Skip to main content

Interface: StandardModalProperties

Defined in: shared/types/componentProps.ts:457

Modal/dialog component properties.

Remarksโ€‹

This interface provides a standard template for modal and dialog components with proper accessibility support.

Extendsโ€‹

Propertiesโ€‹

children?โ€‹

readonly optional children: ReactNode

Defined in: shared/types/componentProps.ts:35

Component content (text, elements, or other components)

Inherited fromโ€‹

CoreComponentProperties.children


className?โ€‹

readonly optional className: string

Defined in: shared/types/componentProps.ts:37

Additional CSS classes for styling customization

Inherited fromโ€‹

CoreComponentProperties.className


disabled?โ€‹

readonly optional disabled: boolean

Defined in: shared/types/componentProps.ts:39

Whether the component is disabled and non-interactive

Inherited fromโ€‹

CoreComponentProperties.disabled


aria-describedby?โ€‹

readonly optional aria-describedby: string

Defined in: shared/types/componentProps.ts:53

ARIA described-by reference for additional descriptions

Inherited fromโ€‹

AccessibilityProperties.aria-describedby


aria-label?โ€‹

readonly optional aria-label: string

Defined in: shared/types/componentProps.ts:55

ARIA label for screen readers

Inherited fromโ€‹

AccessibilityProperties.aria-label


aria-labelledby?โ€‹

readonly optional aria-labelledby: string

Defined in: shared/types/componentProps.ts:57

ARIA labelledby reference for complex labeling

Inherited fromโ€‹

AccessibilityProperties.aria-labelledby


aria-level?โ€‹

readonly optional aria-level: number

Defined in: shared/types/componentProps.ts:59

ARIA heading level for elements using role="heading"

Inherited fromโ€‹

AccessibilityProperties.aria-level


role?โ€‹

readonly optional role: string

Defined in: shared/types/componentProps.ts:61

Role attribute for semantic meaning

Inherited fromโ€‹

AccessibilityProperties.role


tabIndex?โ€‹

readonly optional tabIndex: number

Defined in: shared/types/componentProps.ts:63

Tab index for keyboard navigation

Inherited fromโ€‹

AccessibilityProperties.tabIndex


closeOnEscape?โ€‹

readonly optional closeOnEscape: boolean

Defined in: shared/types/componentProps.ts:461

Whether pressing escape closes the modal


closeOnOutsideClick?โ€‹

readonly optional closeOnOutsideClick: boolean

Defined in: shared/types/componentProps.ts:463

Whether clicking outside closes the modal


onClose()โ€‹

readonly onClose: () => void

Defined in: shared/types/componentProps.ts:465

Handler called when modal should close

Returnsโ€‹

void


openโ€‹

readonly open: boolean

Defined in: shared/types/componentProps.ts:467

Whether the modal is currently open


size?โ€‹

readonly optional size: ComponentSize

Defined in: shared/types/componentProps.ts:469

Size variant for the modal


titleโ€‹

readonly title: string

Defined in: shared/types/componentProps.ts:471

Modal title for accessibility