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
ImageDataobject (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.
Browser compatibility
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
ImageDataType | No | No | 54 | No | Yes |
getPanel | No | No | 54 | No | Yes |
getTitle | No | No | 54 | No | Yes |
setIcon | No | No | 54 | No | Yes |
setPanel | No | No | 54 | No | Yes |
setTitle | No | No | 54 | No | Yes |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.