API
API reference for Dialog Template
import { BwcDialogTemplateModule } from '@aviato/components/dialog-template';
See Angular Material Dialog API
BwcDialogTemplateModule helps the consumer not to worry about the structure and styling of a dialog. It will also help to have a consistent user experience for the end-user.
Consumer needs to add an additional class to the overlay panel: .bwc-overlay-pane
Name |
Description |
---|---|
@Input() isContentScrollable |
boolean Optional parameter. Parameter to mentioned wether the content section of dialog is scrollable. The appearance of the dialog will be different from the simple dialog appearance. The title and action sections will have an elevation. Default: false |
@Input() isContentDialog |
boolean Optional parameter. Parameter to mentioned wether it's a content dialog or not. A content dialog doesn't have any actions except for the close button. Default: false |
@Input() isLarge |
boolean Optional parameter. Parameter to create a large size content or scrollable dialog Default: false |
@Input() dialogConfirmData |
any Mandatory parameter if isContentDialog is false. Parameter to pass data when the dialog has been confirmed. |
@Input() isHeaderFlat |
boolean Optional parameter. Parameter to create flat Header without box-shadow Default: false |
Internationalization
Name |
Description |
---|---|
@Input() dialogLabels |
BwcDialogTemplateLabelsType closeDialogAriaLabel: string;dialogTitle: string;dialogDismissive: string;dialogConfirming: string; |
Examples
Content dialog- regular
Content dialog - large
Content dialog- large (scrollable)