| Type | Object |
|---|---|
| Mandatory | No |
| Manifest version | 2 or higher |
| Example |
|
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.
The sidebar_action key enables you to define the default properties for the sidebar. You can change these properties at runtime using the sidebarAction API.
The sidebar_action key is an object that may have any of the properties listed below. The only mandatory property is default_panel.
| Name | Type | Description |
|---|---|---|
browser_style |
Boolean |
Optional, defaulting to Use this to include a stylesheet in your popup that will make it look consistent with the browser's UI and with other extensions that use the In Firefox, the stylesheet can be seen at chrome://browser/content/extension.css, or chrome://browser/content/extension-mac.css on macOS. When setting dimensions, be aware that this style sheet currently sets The Firefox Style Guide describes the classes you can apply to elements in the sidebar in order to get particular styles. |
default_icon |
Object or String |
Use this to specify one or more icons for the sidebar. The icon is shown in the browser's UI for opening and closing sidebars. Icons are specified as URLs relative to the manifest.json file itself. You can specify a single icon file by supplying a string here: To specify multiple icons in different sizes, specify an object here. The name of each property is the icon's height in pixels, and must be convertible to an integer. The value is the URL. For example: See Choosing icon sizes for more guidance on this. This property is optional: if it is omitted, the sidebar doesn't get an icon. |
default_panel |
String |
The path to an HTML file that specifies the sidebar's contents. The HTML file may include CSS and JavaScript files using Unlike a normal web page, JavaScript running in the panel can access all the WebExtension APIs (subject, of course, to the extension having the appropriate permissions). This property is mandatory. This is a localizable property. |
default_title |
String |
Title for the sidebar. This is used in the browser UI for listing and opening sidebars, and is displayed at the top of the sidebar when it is open. This property is optional: if it is omitted, the sidebar's title is the extension's This is a localizable property. |
open_at_install |
Boolean | Optional, defaulting to true. Determines whether the sidebar should open on install. The default behavior is to open the sidebar when installation is completed. |
"sidebar_action": {
"default_icon": "sidebar.svg",
"default_title": "My sidebar!",
"default_panel": "sidebar.html",
"browser_style": true
}
For a simple example of an extension that uses a sidebar, see annotate-page.
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
sidebar_action |
No | No | 54 | ? | 30 | No | ? | ? | No | ? | No | ? |
browser_style |
No | No | 55 | ? | No | No | ? | ? | No | ? | No | ? |
default_icon |
No | No | 54 | ? |
30SVG icons are not supported. |
No | ? | ? | No | ? | No | ? |
default_panel |
No | No | 54 | ? | 30 | No | ? | ? | No | ? | No | ? |
default_title |
No | No | 54 | ? | 30 | No | ? | ? | No | ? | No | ? |
open_at_install |
No | No | 62 | ? | No | No | ? | ? | No | ? | No | ? |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action