Gets and sets properties of an extension's sidebar.

A sidebar is a pane that is displayed at the left-hand side of the browser window, next to the web page. The browser provides a UI that enables the user to see the currently available sidebars and to select a sidebar to display. Using the sidebar_action manifest.json key, an extension can define its own sidebar. Using the sidebarAction API described here, an extension can get and set the sidebar's properties.

The sidebarAction API is closely modeled on the browserAction API.

The sidebarAction API is based on Opera's sidebarAction API. However, note that the following are not yet supported: setBadgeText(), getBadgeText(), setBadgeBackgroundColor(), getBadgeBackgroundColor(), onFocus, onBlur.

Types

sidebarAction.ImageDataType
Pixel data for an image. Must be an ImageData object (for example, from a <canvas> element).

Functions

sidebarAction.setPanel()
Sets the sidebar's panel.
sidebarAction.getPanel()
Gets the sidebar's panel.
sidebarAction.setTitle()
Sets the sidebar's title. This will be displayed in any UI provided by the browser to list sidebars, such as a menu.
sidebarAction.getTitle()
Gets the sidebar's title.
sidebarAction.setIcon()
Sets the sidebar's icon.
sidebarAction.open()
Opens the sidebar.
sidebarAction.close()
Closes the sidebar.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
ImageDataType No No54 No (Yes)
close No No57 No No
getPanel No No54 No (Yes)
getTitle No No54 No (Yes)
open No No57 No No
setIcon No No54 No (Yes)
setPanel No No54 No (Yes)
setTitle No No54 No (Yes)

Example add-ons

Acknowledgements

This API is based on Opera's chrome.sidebarAction API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, andrewtruongmoz, KainHaart
 Last updated by: wbamberg,