Sets the browser action's title. The title is displayed in a tooltip over the browser action's icon. You can pass a tabId
in as an optional parameter — if you do this then the title is changed only for the given tab. Tabs without a specific title will inherit the global title text, which defaults to the default_title
or name
specified in the manifest.
Syntax
browser.browserAction.setTitle( details // object )
Parameters
details
object
. The new title and optionally the ID of the tab to target.-
title
-
string
ornull
. The string the browser action should display when moused over.Use an empty string -
""
- if you don't want any title.If a
tabId
is specified,null
removes the tab-specific title so that the tab inherits the global title. Otherwise it reverts the global title to the default value. tabId
Optional-
integer
. Sets the title only for the given tab. If omitted, the global title is set instead.The title is reset automatically when the tab is closed.
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 | 15 | 45 | 55 | Yes |
The title property of the details parameter can be set to null . | No | No | 59 | No | No |
Examples
This code switches the title between "this" and "that" each time the user clicks the browser action:
function toggleTitle(title) { if (title == "this") { browser.browserAction.setTitle({title: "that"}); } else { browser.browserAction.setTitle({title: "this"}); } } browser.browserAction.onClicked.addListener(() => { var gettingTitle = browser.browserAction.getTitle({}); gettingTitle.then(toggleTitle); });
Example extensions
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.