W3cubDocs

/Web APIs

Window: sidebar property

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Warning: This non-standard Firefox-only alias of the window.external property has been removed.

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

Instance 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)

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.

Specifications

Mozilla-specific. Not part of any standard.

Browser compatibility

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Window/sidebar