[ADF-4406] - Confirm Dialog doesn't support a third extra button option to be customised (#4608)

* [ADF-4406] - Confirm Dialog doesn't support a third extra button option to be customised

* * comments fixed

* * docs and test added
This commit is contained in:
dhrn 2019-04-23 04:13:10 +05:30 committed by Eugenio Romano
parent b58e040d7e
commit 64391a48fa
7 changed files with 89 additions and 0 deletions

View File

@ -15,4 +15,15 @@
</mat-expansion-panel-header> </mat-expansion-panel-header>
<button mat-raised-button (click)="openConfirmCustomDialog()">Open Custom Dialog</button> <button mat-raised-button (click)="openConfirmCustomDialog()">Open Custom Dialog</button>
</mat-expansion-panel> </mat-expansion-panel>
<mat-expansion-panel>
<mat-expansion-panel-header>
<mat-panel-title>
Confirm Dialog Third Option
</mat-panel-title>
<mat-panel-description>
Provide extra button in the action section
</mat-panel-description>
</mat-expansion-panel-header>
<button mat-raised-button (click)="openConfirmCustomActionDialog()">Open Custom Dialog</button>
</mat-expansion-panel>
</mat-accordion> </mat-accordion>

View File

@ -48,4 +48,22 @@ export class ConfirmDialogExampleComponent {
minWidth: '250px' minWidth: '250px'
}); });
} }
openConfirmCustomActionDialog() {
const thirdOptionLabel = 'Yes. Don\'t Show it again';
const dialog = this.dialog.open(ConfirmDialogComponent, {
data: {
title: 'Upload',
thirdOptionLabel: thirdOptionLabel,
message: `This is the default message`
},
minWidth: '250px'
});
dialog.afterClosed().subscribe((status) => {
// do the third option label operation
if ( status === thirdOptionLabel) {
// console.log('third option clicked');
}
});
}
} }

View File

@ -10,7 +10,19 @@ Last reviewed: 2019-01-22
Requests a yes/no choice from the user. Requests a yes/no choice from the user.
![Confirm dialog](../../docassets/images/ConfirmDialog.png) ![Confirm dialog](../../docassets/images/ConfirmDialog.png)
![Confirm dialog](../../docassets/images/ConfirmDialogYesAll.png)
## Dialog inputs
| Name | Type | Default value | Description |
| ---- | ---- | ---- | ----------- |
| title | `string` | `Confirm` | It will be placed in the dialog title section. |
| yesLabel | `string` | `yes` | It will be placed first in the dialog action section |
| noLabel | `string` | `no`| It will be placed last in the dialog action section |
| thirdOptionLabel (optional) | `string` | | It is not a mandatory input. it will be rendered in between yes and no label |
| message | `string` | `Do you want to proceed?` | It will be rendered in the dialog content area |
| htmlContent | `html` | | It will be rendered in the dialog content area |
*note*: `if input is not passed, default value will be rendered`
## Basic Usage ## Basic Usage
```ts ```ts
@ -65,6 +77,26 @@ dialogRef.afterClosed().subscribe((result) => {
}); });
``` ```
### Rendering with thirdOptionLabel
```
const thirdOptionLabel = "YES. DON'T SHOW IT AGAIN";
const dialog = this.dialog.open(ConfirmDialogComponent, {
data: {
title: 'Upload',
thirdOptionLabel: thirdOptionLabel,
message: `This is the default message`
},
minWidth: '250px'
});
dialog.afterClosed().subscribe((status) => {
// do the third option label operation
if ( status === thirdOptionLabel) {
// console.log('third option clicked');
}
});
```
## Details ## Details
This component lets the user make a yes/no choice to confirm an action. Use the This component lets the user make a yes/no choice to confirm an action. Use the

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

View File

@ -12,6 +12,7 @@
<span class="adf-dialog-spacer" data-automation-id="adf-confirm-dialog-spacer"></span> <span class="adf-dialog-spacer" data-automation-id="adf-confirm-dialog-spacer"></span>
<button id="adf-confirm-accept" mat-button color="primary" data-automation-id="adf-confirm-dialog-confirmation" <button id="adf-confirm-accept" mat-button color="primary" data-automation-id="adf-confirm-dialog-confirmation"
[mat-dialog-close]="true">{{ yesLabel | translate }}</button> [mat-dialog-close]="true">{{ yesLabel | translate }}</button>
<button id="adf-confirm-all" mat-button *ngIf="thirdOptionLabel" [mat-dialog-close]="thirdOptionLabel" data-automation-id="adf-confirm-dialog-confirm-all">{{ thirdOptionLabel | translate }}</button>
<button id="adf-confirm-cancel" mat-button [mat-dialog-close]="false" data-automation-id="adf-confirm-dialog-reject" <button id="adf-confirm-cancel" mat-button [mat-dialog-close]="false" data-automation-id="adf-confirm-dialog-reject"
cdkFocusInitial>{{ noLabel | translate }}</button> cdkFocusInitial>{{ noLabel | translate }}</button>
</mat-dialog-actions> </mat-dialog-actions>

View File

@ -26,6 +26,7 @@ import { By } from '@angular/platform-browser';
describe('Confirm Dialog Component', () => { describe('Confirm Dialog Component', () => {
let fixture: ComponentFixture<ConfirmDialogComponent>; let fixture: ComponentFixture<ConfirmDialogComponent>;
let component: ConfirmDialogComponent; let component: ConfirmDialogComponent;
const dialogRef = { const dialogRef = {
close: jasmine.createSpy('close') close: jasmine.createSpy('close')
}; };
@ -140,4 +141,27 @@ describe('Confirm Dialog Component', () => {
expect(messageElement.nativeElement.innerText).toBe('MAYBE NO'); expect(messageElement.nativeElement.innerText).toBe('MAYBE NO');
}); });
}); });
describe('thirdOptionLabel is given', () => {
it('should NOT render the thirdOption if is thirdOptionLabel is not passed', () => {
component.thirdOptionLabel = undefined;
fixture.detectChanges();
const thirdOptionElement = fixture.debugElement.query(
By.css('[data-automation-id="adf-confirm-dialog-confirm-all"]')
);
expect(thirdOptionElement).toBeFalsy();
});
it('should render the thirdOption if thirdOptionLabel is passed', () => {
component.thirdOptionLabel = 'Yes All';
fixture.detectChanges();
const thirdOptionElement = fixture.debugElement.query(
By.css('[data-automation-id="adf-confirm-dialog-confirm-all"]')
);
expect(thirdOptionElement).not.toBeNull();
expect(thirdOptionElement.nativeElement.innerText).toBe('YES ALL');
});
});
}); });

View File

@ -32,6 +32,7 @@ export class ConfirmDialogComponent {
message: string; message: string;
yesLabel: string; yesLabel: string;
noLabel: string; noLabel: string;
thirdOptionLabel: string;
htmlContent: string; htmlContent: string;
constructor(@Inject(MAT_DIALOG_DATA) data, private sanitizer: DomSanitizer) { constructor(@Inject(MAT_DIALOG_DATA) data, private sanitizer: DomSanitizer) {
@ -39,6 +40,7 @@ export class ConfirmDialogComponent {
this.title = data.title || 'ADF_CONFIRM_DIALOG.CONFIRM'; this.title = data.title || 'ADF_CONFIRM_DIALOG.CONFIRM';
this.message = data.message || 'ADF_CONFIRM_DIALOG.MESSAGE'; this.message = data.message || 'ADF_CONFIRM_DIALOG.MESSAGE';
this.yesLabel = data.yesLabel || 'ADF_CONFIRM_DIALOG.YES_LABEL'; this.yesLabel = data.yesLabel || 'ADF_CONFIRM_DIALOG.YES_LABEL';
this.thirdOptionLabel = data.thirdOptionLabel;
this.noLabel = data.noLabel || 'ADF_CONFIRM_DIALOG.NO_LABEL'; this.noLabel = data.noLabel || 'ADF_CONFIRM_DIALOG.NO_LABEL';
this.htmlContent = data.htmlContent; this.htmlContent = data.htmlContent;
} }
@ -46,4 +48,5 @@ export class ConfirmDialogComponent {
public sanitizedHtmlContent() { public sanitizedHtmlContent() {
return this.sanitizer.sanitize(SecurityContext.HTML, this.htmlContent); return this.sanitizer.sanitize(SecurityContext.HTML, this.htmlContent);
} }
} }