Class Sidebar

Methods for interacting with Sidebar.

Hierarchy

SdkModule
- Sidebar

Index

Methods

registerScriptTab removeScriptTab

Methods

registerScriptTab

registerScriptTab(): Promise<RegisterSidebarTabResult>
Add a new tab to the Scripts sidebar and return its DOM elements: a tab label and a tab container. When the method resolves, both elements are available in the DOM. Userscripts must append a text label (or some icon) to the tabLabel element and tab content to the tabPane element.

Returns Promise<RegisterSidebarTabResult>
a sidebar tab label element and a tab pane element

Throws
InvalidStateError if the tab with the specified scriptId already exists

removeScriptTab

removeScriptTab(): void
Remove the tab from the Scripts sidebar

Returns void
Throws
InvalidStateError if the tab with the specified scriptId doesn't exist