Gets the background color of the browser action's badge.
This is an asynchronous function that returns a Promise.
Syntax
browser.browserAction.getBadgeBackgroundColor( details // object )
Parameters
detailsobject.tabIdOptionalinteger. Specifies the tab to get the badge background color from.windowIdOptionalinteger. Specifies the window from which to get the badge background color.
- If
windowIdandtabIdare both supplied, the function fails. - If
windowIdandtabIdare both omitted, the global badge background color is returned.
Return value
A Promise that will be fulfilled with the retrieved color as a browserAction.ColorArray.
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.
Update compatibility data on GitHub
| Desktop | Mobile | ||||
|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Opera | Firefox for Android | |
| Basic support | Chrome Full support Yes | Edge Full support 14 | Firefox Full support 45 | Opera Full support Yes | Firefox Android No support No |
details.windowId | Chrome No support No | Edge No support No | Firefox Full support 62 | Opera No support No | Firefox Android No support No |
Legend
- Full support
- Full support
- No support
- No support
Examples
Log the badge's background color:
function onGot(color) {
console.log(color);
}
function onFailure(error) {
console.log(error);
}
browser.browserAction.getBadgeBackgroundColor({}).then(onGot, onFailure);
Acknowledgements
This API is based on Chromium's chrome.browserAction API. This documentation is derived from browser_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.
Document Tags and Contributors
Tags:
Contributors to this page:
hellosct1,
Loirooriol,
irenesmith,
meandave,
michael-zapata,
Makyen,
chrisdavidmills,
wbamberg
Last updated by:
hellosct1,