mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
c5ac798c5b
* [ADF-4327] added templating for content dialog * [ADF-4327] added unit test and documentation
76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
---
|
|
Title: Confirm dialog component
|
|
Added: v2.3.0
|
|
Status: Active
|
|
Last reviewed: 2019-01-22
|
|
---
|
|
|
|
# [Confirm dialog component](../../../lib/content-services/dialogs/confirm.dialog.ts "Defined in confirm.dialog.ts")
|
|
|
|
Requests a yes/no choice from the user.
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```ts
|
|
constructor(private dialog: MatDialog) {}
|
|
|
|
...
|
|
|
|
let files = [
|
|
// Files defined here...
|
|
];
|
|
|
|
const dialogRef = this.dialog.open(ConfirmDialogComponent, {
|
|
data: {
|
|
title: 'Upload',
|
|
message: `Are you sure you want to upload ${files.length} file(s)?`
|
|
},
|
|
minWidth: '250px'
|
|
});
|
|
|
|
dialogRef.afterClosed().subscribe((result) => {
|
|
if (result === true) {
|
|
event.resumeUpload();
|
|
}
|
|
});
|
|
```
|
|
|
|
### Rendering custom html body
|
|
It is possible now to render a custom html instead of a plain message as confirm body via the attribute `htmlContent`. The html will be sanitized and then showed.
|
|
|
|
|
|
```ts
|
|
constructor(private dialog: MatDialog) {}
|
|
|
|
...
|
|
|
|
let files = [
|
|
// Files defined here...
|
|
];
|
|
|
|
const dialogRef = this.dialog.open(ConfirmDialogComponent, {
|
|
data: {
|
|
title: 'Upload',
|
|
htmlContent: '<div> <p>A</p> <p>Custom</p> <p>Content</p> </div>'
|
|
},
|
|
minWidth: '250px'
|
|
});
|
|
|
|
dialogRef.afterClosed().subscribe((result) => {
|
|
if (result === true) {
|
|
event.resumeUpload();
|
|
}
|
|
});
|
|
```
|
|
|
|
## Details
|
|
|
|
This component lets the user make a yes/no choice to confirm an action. Use the
|
|
Angular [`MatDialog`](https://material.angular.io/components/dialog/overview)
|
|
service to open the dialog, as shown in the example, and pass a `data` object
|
|
with properties for the `title` and `message` to show. The `afterClosed` event
|
|
of the [`MatDialog`](https://material.angular.io/components/dialog/overview)
|
|
gives you the user's choice via the `result` parameter.
|