Skip to main content

Interface: StandardModalProperties

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

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:33

Component content (text, elements, or other components)

Inherited from​

CoreComponentProperties.children

className?​

readonly optional className: string

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

Additional CSS classes for styling customization

Inherited from​

CoreComponentProperties.className

disabled?​

readonly optional disabled: boolean

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

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:49

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:51

ARIA label for screen readers

Inherited from​

AccessibilityProperties.aria-label

aria-labelledby?​

readonly optional aria-labelledby: string

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

ARIA labelledby reference for complex labeling

Inherited from​

AccessibilityProperties.aria-labelledby

role?​

readonly optional role: string

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

Role attribute for semantic meaning

Inherited from​

AccessibilityProperties.role

tabIndex?​

readonly optional tabIndex: number

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

Tab index for keyboard navigation

Inherited from​

AccessibilityProperties.tabIndex

closeOnEscape?​

readonly optional closeOnEscape: boolean

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

Whether pressing escape closes the modal

closeOnOutsideClick?​

readonly optional closeOnOutsideClick: boolean

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

Whether clicking outside closes the modal

onClose()​

readonly onClose: () => void

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

Handler called when modal should close

Returns​

void

open​

readonly open: boolean

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

Whether the modal is currently open

size?​

readonly optional size: ComponentSize

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

Size variant for the modal

title​

readonly title: string

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

Modal title for accessibility