sidebarAction

Gets and sets properties of an extension's sidebar.

A sidebar is a pane displayed at the left or right of a web page. The browser provides a UI that enables the user to see the available sidebars and select one to display. An extension defines sidebars using the sidebar_action manifest.json key. The extension can then get and set the sidebar's properties using this API.

Note: Chrome provides support for sidebars through the sidePanel API. This API is not compatible with sidebarAction.

The sidebarAction API is based on Opera's sidebarAction API and closely modeled on the browserAction API. However, Firefox has not implemented setBadgeText(), getBadgeText(), setBadgeBackgroundColor(), getBadgeBackgroundColor(), onFocus, and onBlur.

Types

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

Functions

sidebarAction.close(): Closes the sidebar.
sidebarAction.getPanel(): Gets the sidebar's panel.
sidebarAction.getTitle(): Gets the sidebar's title.
sidebarAction.isOpen(): Checks whether the sidebar is open.
sidebarAction.open(): Opens the sidebar.
sidebarAction.setIcon(): Sets the sidebar's icon.
sidebarAction.setPanel(): Sets the sidebar's panel.
sidebarAction.setTitle(): Sets the sidebar's title. This title is displayed in any UI the browser provides to list sidebars, such as a menu.
sidebarAction.toggle(): Toggles the visibility of the sidebar.

Examples

annotate-page

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Firefox for Android	Safari on iOS
`sidebarAction`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`ImageDataType`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`close`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 57 (Release date: 2017-11-14) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`getBadgeBackgroundColor`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`getBadgeText`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`getPanel`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`getPanel.details`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`details.windowId`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`getTitle`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`getTitle.details`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`details.windowId`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`isOpen`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 59 (Release date: 2018-03-13) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`onBlur`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`onFocus`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`open`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 57 (Release date: 2017-11-14) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setBadgeBackgroundColor`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setBadgeText`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setIcon`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setIcon.details`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`details.windowId`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
The `path` and `imageData` properties of the `details` parameter can be set to `null`.	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 59 (Release date: 2018-03-13) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setPanel`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setPanel.details`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`details.windowId`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
The `panel` property of the `details` parameter can be set to `null`.	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 59 (Release date: 2018-03-13) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setTitle`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 54 (Release date: 2017-06-13) footnote Full support	Opera – Full support Opera 30 (Release date: 2015-06-09) footnote Full support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`setTitle.details`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`details.windowId`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 61 (Release date: 2018-06-26) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
The `title` property of the `details` parameter can be set to `null`.	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 59 (Release date: 2018-03-13) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support
`toggle`	Chrome – No support Chrome footnote No support	Edge – No support Edge footnote No support	Firefox – Full support Firefox 73 (Release date: 2020-02-11) footnote Full support	Opera – No support Opera footnote No support	Safari – No support Safari footnote No support	Firefox for Android – No support Firefox for Android footnote No support	Safari on iOS – No support Safari on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support

This page was last modified on Jul 17, 2025 by MDN contributors.

Visit Mozilla Corporation’s not-for-profit parent, the Mozilla Foundation.
Portions of this content are ©1998–2026 by individual mozilla.org contributors. Content available under a Creative Commons license.

sidebarAction

Types

Functions

Examples

Browser compatibility

Legend