Interface PaneOptions

Defines single side pane.

See

createPane

Hierarchy

  • PaneOptions

Properties

alwaysRender? canClose? hidden? hideHeader? imageSrc? isSelected? keepBadgeOnSelect? paneId? title? width?

Properties

Optional alwaysRender

alwaysRender?: boolean

Prevents the pane from unmounting when it is hidden.

Optional canClose

canClose?: boolean

Whether the pane header will show a close button or not.

Optional hidden

hidden?: boolean

Hides the pane and tab.

Optional hideHeader

hideHeader?: boolean

Hides the header pane, including the title and close button. Default value is false.

Optional imageSrc

imageSrc?: string

The path of the icon to show in the panel switcher control.

Optional isSelected

isSelected?: boolean

When set to false, the created pane is not selected and leaves the existing pane selected. It also does not expand the pane if collapsed.

Optional keepBadgeOnSelect

keepBadgeOnSelect?: boolean

Prevents the badge from getting cleared when the pane becomes selected.

Optional paneId

paneId?: string

The ID of the new pane. If the value is not passed, the ID value is auto-generated.

Optional title

title?: string

The title of the pane. Used in pane header and for tooltip.

Optional width

width?: number

The width of the pane in pixels.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc