Skip to main content
Version: 3.0.0-beta

Interface: SideDialogPanelProps

Props used to open a side dialog

Properties​

additional?​

optional additional: any

Use this prop to store additional data in the panel

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:80


component​

component: ReactNode

The component type that will be rendered

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:52


key​

key: string

A key that identifies this panel

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:47


onClose()?​

optional onClose: () => void

Callback when the panel is closed

Returns​

void

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:75


parentUrlPath?​

optional parentUrlPath: string

If the navigation stack is empty (you landed in the urlPath url), what url path to change to when the panel gets closed.

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:70


urlPath?​

optional urlPath: string

When open, change the URL to this path. Note that if you want to restore state from a URL you need to add the logic yourself by listening to URL updates, and probably call open.

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:64


width?​

optional width: string

Optional width of the panel

Defined in​

packages/firecms_core/src/types/side_dialogs_controller.tsx:57

Sign up to our newsletter to get the latest news and updates. No spam!