bookmarks.onChanged

Fired when there is a change to:

  • the title or URL of a bookmark
  • the name of a folder.

Syntax

js
browser.bookmarks.onChanged.addListener(listener)
browser.bookmarks.onChanged.removeListener(listener)
browser.bookmarks.onChanged.hasListener(listener)

Events have three functions:

addListener(listener)

Adds a listener to this event.

removeListener(listener)

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

hasListener(listener)

Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

listener

The function called when this event occurs. The function is passed these arguments:

id

string. ID of the item that changed.

changeInfo

object. Object containing two properties: title, a string containing the item's title, and url, a string containing the item's URL. If the item is a folder, url is omitted.

Note: Multiple events may occur when a bookmark changes, and that changeInfo object may contain only the data that has changed, rather than all the data for the bookmark. In other words, if the url for a bookmark changes, the changeInfo may only contain the new url information.

Examples

js
function handleChanged(id, changeInfo) {
  console.log(`Item: ${id} changed`);
  console.log(`Title: ${changeInfo.title}`);
  console.log(`URL: ${changeInfo.url}`);
}
function handleClick() {
  browser.bookmarks.onChanged.addListener(handleChanged);
}
browser.browserAction.onClicked.addListener(handleClick);

Browser compatibility

Note: This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.