SideDialogPanelProps

@firecms/core

---

@firecms/core / SideDialogPanelProps

Interface: SideDialogPanelProps

Defined in: types/side_dialogs_controller.tsx:43

Props used to open a side dialog

Properties

additional?

optional additional: any

Defined in: types/side_dialogs_controller.tsx:81

Use this prop to store additional data in the panel

---

component

component: ReactNode

Defined in: types/side_dialogs_controller.tsx:53

The component type that will be rendered

---

key

key: string

Defined in: types/side_dialogs_controller.tsx:48

A key that identifies this panel

---

onClose()?

optional onClose: () => void

Defined in: types/side_dialogs_controller.tsx:76

Callback when the panel is closed

Returns

void

---

parentUrlPath?

optional parentUrlPath: string

Defined in: types/side_dialogs_controller.tsx:71

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

---

urlPath?

optional urlPath: string

Defined in: types/side_dialogs_controller.tsx:65

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.

---

width?

optional width: string

Defined in: types/side_dialogs_controller.tsx:58

Optional width of the panel