tabs.onUpdated

Fired when a tab is updated.

When the user navigates to a new URL in a tab, this will typically generate several  onUpdated events as various properties of the tabs.Tab object are updated. This includes the url , but also potentially the title and favIconUrl 特性。 status property will cycle through "loading" and "complete" .

This event will also be fired for changes to a tab's properties that don't involve navigation, like pinning and unpinning (which updates the pinned property) and muting or unmuting (which updates the audible and mutedInfo properties).

You can filter this event, making it only fire for tabs whose urls match specific patterns , or for changes to specific properties, or for changes to a specific tab or window, or any combinations of these restrictions.

句法

browser.tabs.onUpdated.addListener(listener[, extraParameters])
browser.tabs.onUpdated.removeListener(listener)
browser.tabs.onUpdated.hasListener(listener)

					

Events have three functions:

addListener(callback[, extraParameters])

Adds a listener to this event.

removeListener(listener)

Stop listening to this event. The listener argument is the listener to remove.

hasListener(listener)

校验是否 listener is registered for this event. Returns true if it is listening, false 否则。

addListener syntax

参数

callback

Function that will be called when this event occurs. The function will be passed the following arguments:

tabId

integer . ID of the tab that was updated.

changeInfo

对象 . Contains properties for the tab properties that have changed. See changeInfo 下文。

tab

tabs.Tab . The new state of the tab.

extraParameters 可选

对象 . A set of filters that restricts the events that will be sent to this listener. This is an object which may have one or more of the following properties. Events will only be sent if they satisfy all the filters given.

urls

数组 . An array of match patterns . Fire the event only for tabs whose current url property matches any one of the patterns.

properties

数组 . An array of strings, which are the names of properties of the tabs.Tab object. Fire this event only for changes to one of the properties named in this array. The following properties may be listed here:

  • "attention"
  • "audible"
  • "discarded"
  • "favIconUrl"
  • "hidden"
  • "isArticle"
  • "mutedInfo"
  • "pinned"
  • "sharingState"
  • "status"
  • "title"
  • "url"

注意: The "url" value is supported since Firefox 88. In Firefox 87 and earlier, "url" changes can be observed by filtering by "status".

tabId

整数 . Fire this event only for the tab identified by this ID.

windowId

整数 . Fire this event only for tabs which are currently in the window identified by this ID.

Additional objects

changeInfo

Lists the changes to the state of the tab that was updated. To learn more about these properties, see the tabs.Tab 文档编制。

attention 可选

boolean . Indicates whether the tab is drawing attention. For example, when the tab displays a modal dialog, attention 将是 true .

audible 可选

boolean . The tab's new audible state.

discarded 可选

boolean . Whether the tab is discarded. A discarded tab is one whose content has been unloaded from memory, but is still visible in the tab strip. Its content gets reloaded the next time it's activated.

favIconUrl 可选

string . The tab's new favicon URL.

hidden 可选

boolean . True if the tab is hidden .

isArticle 可选

boolean . True if the tab is an article and is therefore eligible for display in  Reader Mode .

mutedInfo 可选

tabs.MutedInfo . The tab's new muted state and the reason for the change.

pinned 可选

boolean . The tab's new pinned state.

status 可选

string . The status of the tab. Can be either loading or complete .

title 可选

string . The tab's new title.

url 可选

string . The tab's URL if it has changed.

范例

Listen for and log all the change info and new state:

function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log("Updated tab: " + tabId);
  console.log("Changed attributes: ");
  console.log(changeInfo);
  console.log("New tab Info: ");
  console.log(tabInfo);
}
browser.tabs.onUpdated.addListener(handleUpdated);

						

Log changes to URLs:

function handleUpdated(tabId, changeInfo, tabInfo) {
  if (changeInfo.url) {
    console.log("Tab: " + tabId +
                " URL changed to " + changeInfo.url);
  }
}
browser.tabs.onUpdated.addListener(handleUpdated);

						

Filtering examples

Log changes only to tabs whose url 特性为 matched by "https://developer.mozilla.org/*" or "https://twitter.com/mozdevnet":

const pattern1 = "https://developer.mozilla.org/*";
const pattern2 = "https://twitter.com/mozdevnet";
const filter = {
  urls: [pattern1, pattern2]
}
function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}
browser.tabs.onUpdated.addListener(handleUpdated, filter);

						

Log changes only to the pinned property of tabs (i.e. pin and unpin actions):

const filter = {
  properties: ["pinned"]
}
function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}
browser.tabs.onUpdated.addListener(handleUpdated, filter);

						

Combine both the previous filters: log changes only:

  • pinned property of tabs
  • whose url 特性为 matched by "https://developer.mozilla.org/*" or "https://twitter.com/mozdevnet":
const pattern1 = "https://developer.mozilla.org/*";
const pattern2 = "https://twitter.com/mozdevnet";
const filter = {
  urls: [pattern1, pattern2],
  properties: ["pinned"]
}
function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}
browser.tabs.onUpdated.addListener(
  handleUpdated,
  filter);

						

Log changes only:

  • pinned property of tabs
  • whose url 特性为 matched by "https://developer.mozilla.org/*" or "https://twitter.com/mozdevnet"
  • and which are part of the current browser window at the time the update event is fired:
const pattern1 = "https://developer.mozilla.org/*";
const pattern2 = "https://twitter.com/mozdevnet";
const filter = {
  urls: [pattern1, pattern2],
  properties: ["pinned"],
  windowId: browser.windows.WINDOW_ID_CURRENT
}
function handleUpdated(tabId, changeInfo, tabInfo) {
  console.log(`Updated tab: ${tabId}`);
  console.log("Changed attributes: ", changeInfo);
  console.log("New tab Info: ", tabInfo);
}
browser.tabs.onUpdated.addListener(
  handleUpdated,
  filter);

						

Example extensions

浏览器兼容性

BCD tables only load in the browser

注意: This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

Found a problem with this page?

最后修改: , 由 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
    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
      1. 方法
        1. captureTab()
        2. captureVisibleTab()
        3. connect()
        4. create()
        5. detectLanguage()
        6. discard()
        7. duplicate()
        8. executeScript()
        9. get()
        10. getAllInWindow()
        11. getCurrent()
        12. getSelected()
        13. getZoom()
        14. getZoomSettings()
        15. goBack()
        16. goForward()
        17. hide()
        18. highlight()
        19. insertCSS()
        20. move()
        21. moveInSuccession()
        22. print()
        23. printPreview()
        24. query()
        25. reload()
        26. remove()
        27. removeCSS()
        28. saveAsPDF()
        29. sendMessage()
        30. sendRequest()
        31. setZoom()
        32. setZoomSettings()
        33. show()
        34. toggleReaderMode()
        35. update()
        36. warmup()
      2. 特性
        1. TAB_ID_NONE
      3. 类型
        1. MutedInfo
        2. MutedInfoReason
        3. PageSettings
        4. Tab
        5. TabStatus
        6. WindowType
        7. ZoomSettings
        8. ZoomSettingsMode
        9. ZoomSettingsScope
      4. 事件
        1. onActivated
        2. onActiveChanged
        3. onAttached
        4. onCreated
        5. onDetached
        6. onHighlightChanged
        7. onHighlighted
        8. onMoved
        9. onRemoved
        10. onReplaced
        11. onSelectionChanged
        12. onUpdated
        13. onZoomChange
    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