内容表

• 类型
• 函数
• 事件
• 浏览器兼容性
• Example extensions

browserAction

Adds a button to the browser's toolbar.

A browser action is a button in the browser's toolbar.

You can associate a popup with the button. The popup is specified using HTML, CSS and JavaScript, just like a normal web page. JavaScript running in the popup gets access to all the same WebExtension APIs as your background scripts, but its global context is the popup, not the current page displayed in the browser. To affect web pages you need to communicate with them via messages .

If you specify a popup, it will be shown — and the content will be loaded — when the user clicks the icon. If you do not specify a popup, then when the user clicks the icon an event is dispatched to your extension.

You can define most of a browser action's properties declaratively using the browser_action key in the manifest.json.

With the browserAction API, you can:

• 使用 browserAction.onClicked to listen for clicks on the icon.
• get and set the icon's properties — icon, title, popup, and so on. You can get and set these globally across all tabs, or for a specific tab by passing the tab ID as an additional argument.

类型

browserAction.ColorArray

An array of four integers in the range 0-255 defining an RGBA color.

browserAction.ImageDataType

Pixel data for an image. Must be an ImageData object (for example, from a <canvas> element).

函数

browserAction.setTitle()

Sets the browser action's title. This will be displayed in a tooltip.

browserAction.getTitle()

Gets the browser action's title.

browserAction.setIcon()

Sets the browser action's icon.

browserAction.setPopup()

Sets the HTML document to be opened as a popup when the user clicks on the browser action's icon.

browserAction.getPopup()

Gets the HTML document set as the browser action's popup.

browserAction.openPopup()

Open the browser action's popup.

browserAction.setBadgeText()

Sets the browser action's badge text. The badge is displayed on top of the icon.

browserAction.getBadgeText()

Gets the browser action's badge text.

browserAction.setBadgeBackgroundColor()

Sets the badge's background color.

browserAction.getBadgeBackgroundColor()

Gets the badge's background color.

browserAction.setBadgeTextColor()

Sets the badge's text color.

browserAction.getBadgeTextColor()

Gets the badge's text color.

browserAction.enable()

Enables the browser action for a tab. By default, browser actions are enabled for all tabs.

browserAction.disable()

Disables the browser action for a tab, meaning that it cannot be clicked when that tab is active.

browserAction.isEnabled()

Checks whether the browser action is enabled or not.

事件

browserAction.onClicked

Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.

浏览器兼容性

BCD tables only load in the browser

Example extensions

• bookmark-it
• favourite-colour
• find-across-tabs
• forget-it
• google-userinfo
• native-messaging
• open-my-page-button
• permissions
• runtime-examples
• store-collected-images
• tabs-tabs-tabs

注意： 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.

Found a problem with this page?

• Edit on GitHub
• Source on GitHub
• Report a problem with this content on GitHub
• Want to fix the problem yourself? See our Contribution guide .

最后修改： Oct 26, 2021 , 由 MDN 贡献者

相关话题

1. 浏览器扩展名
2. 快速入门

   1. What are extensions?
   2. Your first extension
   3. Your second extension
   4. Anatomy of an extension
   5. Example extensions
   6. What next?
3. 概念

   1. Using the JavaScript APIs
   2. Content scripts
   3. Match patterns
   4. Working with files
   5. 国际化
   6. Content Security Policy
   7. Native messaging
   8. Differences between API implementations
   9. Chrome incompatibilities
4. 用户界面

   1. 用户界面
   2. Toolbar button
   3. Address bar button
   4. Sidebars
   5. Context menu items
   6. Options page
   7. Extension pages
   8. Notifications
   9. Address bar suggestions
   10. Developer tools panels
5. 如何

   1. Intercept HTTP requests
   2. Modify a web page
   3. Insert external content
   4. Share objects with page scripts
   5. Add a button to the toolbar
   6. Implement a settings page
   7. Work with the Tabs API
   8. Work with the Bookmarks API
   9. Work with the Cookies API
   10. Work with contextual identities
   11. Interact with the clipboard
   12. Build a cross-browser extension
6. Firefox differentiators
7. JavaScript API

   1. Browser support for JavaScript APIs
   2. alarms
   3. bookmarks
   4. browserAction
      1. 方法
         1. disable()
         2. enable()
         3. getBadgeBackgroundColor()
         4. getBadgeText()
         5. getBadgeTextColor()
         6. getPopup()
         7. getTitle()
         8. isEnabled()
         9. openPopup()
         10. setBadgeBackgroundColor()
         11. setBadgeText()
         12. setBadgeTextColor()
         13. setIcon()
         14. setPopup()
         15. setTitle()
      2. 类型
         1. ColorArray
         2. ImageDataType
      3. 事件
         1. onClicked
   5. browserSettings
   6. browsingData
   7. captivePortal
   8. clipboard
   9. 命令
   10. contentScripts
   11. contextualIdentities
   12. Cookie
   13. devtools
   14. dns
   15. downloads
   16. events
   17. extension
   18. extensionTypes
   19. find
   20. history
   21. i18n
   22. identity
   23. idle
   24. management
   25. menus
   26. notifications
   27. omnibox
   28. pageAction
   29. permissions
   30. pkcs11
   31. privacy
   32. proxy
   33. runtime
   34. search
   35. sessions
   36. sidebarAction
   37. storage
   38. tabs
   39. theme
   40. topSites
   41. 类型
   42. userScripts
   43. webNavigation
   44. webRequest
   45. windows
8. Manifest keys

   1. 介绍

   1. 作者
   2. background
   3. browser_action
   4. browser_specific_settings
   5. chrome_settings_overrides
   6. chrome_url_overrides
   7. 命令
   8. content_scripts
   9. content_security_policy
   10. default_locale
   11. description
   12. developer
   13. devtools_page
   14. dictionaries
   15. externally_connectable
   16. homepage_url
   17. icons
   18. incognito
   19. manifest_version
   20. name
   21. offline_enabled
   22. omnibox
   23. optional_permissions
   24. options_page
   25. options_ui
   26. page_action
   27. permissions
   28. protocol_handlers
   29. short_name
   30. sidebar_action
   31. storage
   32. theme
   33. theme_experiment
   34. user_scripts
   35. version
   36. version_name
   37. web_accessible_resources
9. Extension Workshop

   1. Develop
   2. Publish
   3. Manage
   4. Enterprise
10. Contact us
11. Channels

    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat