Web/API/Window/sidebar

From Get docs

Non-standard This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.


Returns a sidebar object which contains several methods for registering add-ons with the browser.

Methods

The sidebar object returned has the following methods:

Method Description (SeaMonkey) Description (Firefox)
addPanel(title, contentURL, "") Adds a sidebar panel. Obsolete since Firefox 23 (only present in SeaMonkey).

End users can use the "load this bookmark in the sidebar" option instead. Also see Creating a Firefox sidebar.

addPersistentPanel(title, contentURL, "") Adds a sidebar panel, which is able to work in the background.
AddSearchProvider(descriptionURL) Dummy function; does nothing. See Autodiscovery of search plugins.
addSearchEngine(engineURL, iconURL, suggestedTitle, suggestedCategory) Obsolete since Gecko 44

Installs a search engine (Sherlock). Adding Sherlock search engines contains more details.

Note: This was made obsolete in Firefox 44, and has been removed completely in Firefox 59.


IsSearchProviderInstalled(descriptionURL) Indicates if a specific search provider (OpenSearch) is installed.

Specification

Mozilla-specific. Not part of any standard.

Browser compatibility

Update compatibility data on GitHub

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet

sidebar

Deprecated'Non-standard'

Chrome

No support No

Edge

No support No

Firefox Full support Yes

Notes'

Full support Yes

Notes'

Notes' From Firefox 78 AddSearchProvider() does nothing, as the specification requires.

IE

?

Opera

?

Safari

?

WebView Android

No support No

Chrome Android

No support No

Firefox Android

Full support Yes

Opera Android

?

Safari iOS

?

Samsung Internet Android

No support No

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Non-standard. Expect poor cross-browser support.'
Non-standard. Expect poor cross-browser support.
Deprecated. Not for use in new websites.'
Deprecated. Not for use in new websites.
See implementation notes.'
See implementation notes.