Skip to main content

Interface: StandardModalProperties

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

Modal/dialog component properties.

Remarks​

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

Hierarchy​

View Summary

Extends​

Properties​

children?​

readonly optional children?: ReactNode

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

Component content (text, elements, or other components)

Inherited from​

CoreComponentProperties.children

className?​

readonly optional className?: string

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

Additional CSS classes for styling customization

Inherited from​

CoreComponentProperties.className

disabled?​

readonly optional disabled?: boolean

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

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

ARIA described-by reference for additional descriptions

Inherited from​

AccessibilityProperties.aria-describedby

aria-disabled?​

readonly optional aria-disabled?: boolean

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

ARIA disabled state for interactive controls that are visually disabled

Inherited from​

AccessibilityProperties.aria-disabled

aria-label?​

readonly optional aria-label?: string

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

ARIA label for screen readers

Inherited from​

AccessibilityProperties.aria-label

aria-labelledby?​

readonly optional aria-labelledby?: string

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

ARIA labelledby reference for complex labeling

Inherited from​

AccessibilityProperties.aria-labelledby

aria-level?​

readonly optional aria-level?: number

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

ARIA heading level for elements using role="heading"

Inherited from​

AccessibilityProperties.aria-level

role?​

readonly optional role?: string

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

Role attribute for semantic meaning

Inherited from​

AccessibilityProperties.role

tabIndex?​

readonly optional tabIndex?: number

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

Tab index for keyboard navigation

Inherited from​

AccessibilityProperties.tabIndex

closeOnEscape?​

readonly optional closeOnEscape?: boolean

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

Whether pressing escape closes the modal

closeOnOutsideClick?​

readonly optional closeOnOutsideClick?: boolean

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

Whether clicking outside closes the modal

onClose​

readonly onClose: () => void

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

Handler called when modal should close

Returns​

void

open​

readonly open: boolean

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

Whether the modal is currently open

size?​

readonly optional size?: ComponentSize

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

Size variant for the modal

title​

readonly title: string

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

Modal title for accessibility