Skip to main content
Version: 2.0.0-alpha

Interface: SideDialogPanelProps<P>

Props used to open a side dialog

Type parameters

NameType
Pany

Properties

Component

Component: ReactChild

The component type that will be rendered

Defined in

lib/src/models/side_dialogs_controller.tsx:45


key

key: string

A key that identifies this panel

Defined in

lib/src/models/side_dialogs_controller.tsx:40


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

lib/src/models/side_dialogs_controller.tsx:63


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

lib/src/models/side_dialogs_controller.tsx:57


width

Optional width: string

Optional width of the panel

Defined in

lib/src/models/side_dialogs_controller.tsx:50