Sets the HTML document to be opened as a popup when the user clicks on the page action's icon.
Syntax
chrome.pageAction.setPopup( details // object )
This API is also available as browser.pageAction.setPopup() in a version that returns a promise.
Parameters
detailsobject.-
tabIdinteger. The ID of the tab for which you want to set the popup.popupstring. URL to the HTML file to show in a popup. If set to an empty string (''), no popup is shown.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
| Basic support | Yes | Yes | 45.0 | 50.0 | 33 |
Compatibility notes
Firefox for Android
- The 'tabId' parameter is ignored, and the popup is set for all tabs.
Examples
Listen for tabs.onUpdated events, and switch the popup if the loading status changes:
chrome.tabs.onUpdated.addListener((tabId, changeInfo, tabInfo) => {
if (changeInfo.status) {
chrome.pageAction.show(tabId);
if (changeInfo.status == "loading") {
chrome.pageAction.setPopup({
tabId,
popup: "/popups/loading.html"
});
} else {
chrome.pageAction.setPopup({
tabId,
popup: "/popups/complete.html"
});
}
}
});
This API is based on Chromium's chrome.pageAction API. This documentation is derived from page_action.json in the Chromium code.
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.