ContextQMD
Back to Content

sidebarAction.getPanel()

files/en-us/mozilla/add-ons/webextensions/api/sidebaraction/getpanel/index.md

latest3.0 KB
Original Source

Gets a URL to the HTML document that defines the sidebar's contents.

This is an asynchronous function that returns a Promise.

Syntax

js-nolint
let gettingPanel = browser.sidebarAction.getPanel(
  details               // object
)

Parameters

  • details
    • : object. An object with the following properties:
      • tabId {{optional_inline}}
        • : integer. Get the panel for the sidebar specific to the given tab.
      • windowId {{optional_inline}}
        • : integer. Get the panel for the sidebar specific to the given window.
<!---->
  • If windowId and tabId are both supplied, the function fails and the promise it returns is rejected.
  • If windowId and tabId are both omitted, the global panel is returned.

Return value

A Promise that will be fulfilled with a string containing the URL for the panel's document. This will be a fully qualified URL, such as:

url
moz-extension://d1d8a2eb-fe60-f646-af30-a866c5b39942/sidebar.html

Examples

Get the panel's URL:

js
function onGot(sidebarUrl) {
  console.log(sidebarUrl);
}

let gettingPanel = browser.sidebarAction.getPanel({});
gettingPanel.then(onGot);

{{WebExtExamples}}

Browser compatibility

{{Compat}}

[!NOTE] This API is based on Opera's chrome.sidebarAction API.

<!-- // 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. -->