Gets and sets properties of an add-on'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 add-on can define its own sidebar. Using the sidebarAction API described here, an add-on 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.


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


Sets the sidebar's panel.
Gets the sidebar's panel.
Sets the sidebar's title. This will be displayed in any UI provided by the browser to list sidebars, such as a menu.
Gets the sidebar's title.
Sets the sidebar's icon.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
ImageDataType No No 54.0 No Yes
getPanel No No 54.0 No Yes
getTitle No No 54.0 No Yes
setIcon No No 54.0 No Yes
setPanel No No 54.0 No Yes
setTitle No No 54.0 No Yes

Example add-ons


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: KainHaart, wbamberg
 Last updated by: KainHaart,