ShellPlugin

Since v2.x (extraction #370)

Shell plugin for <tbw-grid>.

Configuration Options

Option	Type	Description
header?	ShellHeaderConfig	Shell header bar configuration
toolPanel?	ToolPanelConfig	Tool panel configuration

See Also

• ShellConfig for all configuration options.
• Extends BaseGridPlugin.

Extends BaseGridPlugin

Inherited methods like attach(), detach(), afterRender(), etc. are documented in the base class.

Accessors

isToolPanelOpen

Whether the tool panel sidebar is currently open.

readonly isToolPanelOpen: boolean

---

expandedToolPanelSections

IDs of the currently expanded accordion sections in the tool panel.

readonly expandedToolPanelSections: string[]

---

Methods

openToolPanel()

Open the tool panel sidebar.

openToolPanel(panelId: string, options: OpenToolPanelOptions): void

Parameters

Name	Type	Description
panelId	string	Optional section to expand on open (see ShellController.openToolPanel).
options	OpenToolPanelOptions	Optional open options. In mode: 'dropdown', options.anchor
sets the element the popover anchors to (see OpenToolPanelOptions).

---

closeToolPanel()

Close the tool panel sidebar.

closeToolPanel(): void

---

toggleToolPanel()

Toggle the tool panel sidebar open or closed.

toggleToolPanel(options: OpenToolPanelOptions): void

Parameters

Name	Type	Description
options	OpenToolPanelOptions	Optional open options forwarded when opening (e.g. anchor
for dropdown mode; see OpenToolPanelOptions).

---

toggleToolPanelSection()

Toggle an accordion section expanded or collapsed within the tool panel.

toggleToolPanelSection(sectionId: string): void

Parameters

Name	Type	Description
sectionId	string

---

getToolPanels()

Get all registered tool panel definitions.

getToolPanels(): ToolPanelDefinition[]

---

registerToolPanel()

Register a custom tool panel section.

registerToolPanel(panel: ToolPanelDefinition): void

Parameters

Name	Type	Description
panel	ToolPanelDefinition

---

unregisterToolPanel()

Unregister a custom tool panel section.

unregisterToolPanel(panelId: string): void

Parameters

Name	Type	Description
panelId	string

---

getHeaderContents()

Get all registered header content definitions.

getHeaderContents(): HeaderContentDefinition[]

---

registerHeaderContent()

Register custom header content (rendered in the shell header bar).

registerHeaderContent(content: HeaderContentDefinition): void

Parameters

Name	Type	Description
content	HeaderContentDefinition

---

unregisterHeaderContent()

Unregister custom header content.

unregisterHeaderContent(contentId: string): void

Parameters

Name	Type	Description
contentId	string

---

getToolbarContents()

Get all registered toolbar content definitions.

getToolbarContents(): ToolbarContentDefinition[]

---

registerToolbarContent()

Register custom toolbar content (rendered in the shell toolbar).

registerToolbarContent(content: ToolbarContentDefinition): void

Parameters

Name	Type	Description
content	ToolbarContentDefinition

---

unregisterToolbarContent()

Unregister custom toolbar content.

unregisterToolbarContent(contentId: string): void

Parameters

Name	Type	Description
contentId	string

---