DialogConfig

Overview

• Kind: Interface
• Source: packages/primitives/src/dialog/dialog.types.ts:3

Declaration

interface DialogConfig

Properties

Name	Type	Description
position	DialogPosition	The position of the dialog on the screen.
backdrop	boolean	Whether to show a backdrop behind the dialog.
closeOnBackdropClick	boolean	Whether the dialog should close when the backdrop is clicked.
closeOnEscape	boolean	Whether the dialog should close when the Escape key is pressed.
panelClass?	string | string[]	Custom CSS class for the dialog container.
backdropClass?	string | string[]	Custom CSS class for the backdrop.
width?	string	Width of the dialog.
height?	string	Height of the dialog.
ariaLabelledBy?	string	ID of the element that labels the dialog. Used for aria-labelledby; it is only applied when the element exists in the document. If omitted, a fallback ID is generated and exposed via the template context (let-labelledBy="ariaLabelledBy") so consumers can bind it to a title element.
ariaLabel?	string	Accessible name used when the dialog has no visible title element. Ignored when a valid aria-labelledby reference resolves. A dialog with neither has no accessible name, and a development-mode warning is logged.
ariaDescribedBy?	string	ID of the element that describes the dialog. Used for aria-describedby. If omitted, a fallback ID is generated and exposed via the template context so consumers can bind it to a description element.

Related types

• DialogPosition