Skip to main content

OverlayShellProps

@mandaitor/react


@mandaitor/react / OverlayShellProps

Interface: OverlayShellProps

Defined in: components/OverlayShell.d.ts:5

Props for OverlayShell: open/position/width control, the active mandate, creator inputs, and lifecycle callbacks.

Properties​

activeMandate?​

optional activeMandate?: Mandate

Defined in: components/OverlayShell.d.ts:17

Current active mandate for summary display


availableActions?​

optional availableActions?: ActionOption[]

Defined in: components/OverlayShell.d.ts:19

Available actions for the mandate creator


className?​

optional className?: string

Defined in: components/OverlayShell.d.ts:27

Additional CSS class


defaultOpen?​

optional defaultOpen?: boolean

Defined in: components/OverlayShell.d.ts:9

Default open state when uncontrolled


defaultResources?​

optional defaultResources?: string[]

Defined in: components/OverlayShell.d.ts:21

Default resources for new mandates


onMandateCreated?​

optional onMandateCreated?: (mandate) => void

Defined in: components/OverlayShell.d.ts:23

Callback when a mandate is created

Parameters​

mandate​

Mandate

Returns​

void


onOpenChange?​

optional onOpenChange?: (open) => void

Defined in: components/OverlayShell.d.ts:11

Callback when overlay open state changes

Parameters​

open​

boolean

Returns​

void


onStatusChange?​

optional onStatusChange?: (mandate, newStatus) => void

Defined in: components/OverlayShell.d.ts:25

Callback when a mandate status changes

Parameters​

mandate​

Mandate

newStatus​

MandateStatus

Returns​

void


open?​

optional open?: boolean

Defined in: components/OverlayShell.d.ts:7

Whether the overlay is open


position?​

optional position?: "right" | "left" | "bottom-right" | "bottom-left"

Defined in: components/OverlayShell.d.ts:13

Position of the overlay


width?​

optional width?: number

Defined in: components/OverlayShell.d.ts:15

Width of the overlay panel