Interface PaneObject

Defines methods single side pane.

Hierarchy

  • Omit<PaneOptions, "isSelected" | "hideHeader">
    • PaneObject

Properties

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

Methods

close navigate select

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 imageSrc

imageSrc?: string

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

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.

Methods

close

  • Closes the side pane and removes it from the side bar.

    Returns void

navigate

select

  • Specify whether the pane should be selected or expanded.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc