gov-dialog
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
accessibleCloseLabel | accessible-close-label | Adds accessible label for the dialog close button that is only shown for screen readers. | string | 'Zavřít okno' |
accessibleCloseLabelledBy | accessible-close-labelled-by | A string of identifiers that indicate alternative label elements for closing the dialog window | string | undefined |
accessibleDescribedBy | accessible-described-by | Indicates the id of a component that describes the dialog. | string | undefined |
accessibleLabelledBy | accessible-labelled-by | String of id's that indicates alternative labels elements | string | undefined |
blockBackdropClose | block-backdrop-close | Attribute allowing blocking the backdrop dialog closing | boolean | false |
blockClose | block-close | Attribute allowing blocking the dialog closing | boolean | false |
labelTag | label-tag | Used to change the HTML tag in the dialog label for correct semantic structure | string | 'h2' |
open | open | Attribute for dialog window display | boolean | false |
role | role | Role of dialog | string | 'dialog' |
Events
| Event | Description | Type |
|---|---|---|
gov-close | Emitted when a dialog window closes. | CustomEvent<PointerEvent> |
Methods
setFocus() => Promise<void>
Sets the close button to focus
Returns
Type: Promise<void>
validateAccessibility() => Promise<void>
Validate the WCAG attributes of the component
Returns
Type: Promise<void>
Dependencies
Used by
Depends on
Graph
Built with StencilJS