mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
90 lines
3.0 KiB
Markdown
90 lines
3.0 KiB
Markdown
---
|
|
Title: Login Dialog component
|
|
Added: v2.6.0
|
|
Status: Active
|
|
Last reviewed: 2018-10-02
|
|
---
|
|
|
|
# [Login Dialog component](../../../lib/core/src/lib/login/components/login-dialog.component.ts "Defined in login-dialog.component.ts")
|
|
|
|
Allows a user to perform a login via a dialog.
|
|
|
|
## Details
|
|
|
|
The [Login Dialog component](login-dialog.component.md) allows you to perform a login via a dialog.
|
|
|
|
### Showing the dialog
|
|
|
|
Unlike most components, the [Login Dialog Component](login-dialog.component.md) is typically shown in a dialog box
|
|
rather than the main page and you are responsible for opening the dialog yourself. You can use the
|
|
[Angular Material Dialog](https://material.angular.io/components/dialog/overview) for this,
|
|
as shown in the usage example. ADF provides the [`LoginDialogComponentData`](../../../lib/core/src/lib/login/components/login-dialog-component-data.interface.ts) interface
|
|
to work with the Dialog's
|
|
[data option](https://material.angular.io/components/dialog/overview#sharing-data-with-the-dialog-component-):
|
|
|
|
```ts
|
|
export interface LoginDialogComponentData {
|
|
title: string;
|
|
actionName?: string;
|
|
logged: Subject<any>;
|
|
}
|
|
```
|
|
|
|
The properties are described in the table below:
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| title | `string` | "" | Dialog title |
|
|
| actionName | `string` | "" | Text to appear on the dialog's main action button ("Login", "Access", etc) |
|
|
| logged | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | | Event emitted when the login succeeds. |
|
|
|
|
If you don't want to manage the dialog yourself then it is easier to use the
|
|
[Login Dialog Panel component](login-dialog-panel.component.md), or the
|
|
methods of the [Login Dialog service](../services/login-dialog.service.md), which create
|
|
the dialog for you.
|
|
|
|
### Usage example
|
|
|
|
```ts
|
|
import { MatDialog } from '@angular/material/dialog';
|
|
import { LoginDialogComponentData, LoginDialogComponent} from '@adf/core'
|
|
import { Subject } from 'rxjs/Subject';
|
|
...
|
|
|
|
constructor(dialog: MatDialog ... ) {}
|
|
|
|
openLoginDialog() {
|
|
data: LoginDialogComponentData = {
|
|
title: "Perform a Login",
|
|
actionName: "Access",
|
|
logged: new Subject<any>()
|
|
};
|
|
|
|
this.dialog.open(
|
|
LoginDialogComponent,
|
|
{
|
|
data, panelClass: 'adf-login-dialog',
|
|
width: '630px'
|
|
}
|
|
);
|
|
|
|
data.logged.subscribe(() => {
|
|
// Action after being logged in...
|
|
},
|
|
(error)=>{
|
|
//your error handling
|
|
},
|
|
()=>{
|
|
//action called when an action or cancel is clicked on the dialog
|
|
this.dialog.closeAll();
|
|
});
|
|
}
|
|
```
|
|
|
|
All the results will be streamed to the logged [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present in the [`LoginDialogComponentData`](../../../lib/core/src/lib/login/components/login-dialog-component-data.interface.ts) object passed to the dialog.
|
|
When the dialog action is selected by clicking, the `data.logged` stream will be completed.
|
|
|
|
## See also
|
|
|
|
- [Login component](login.component.md)
|