bookmarks

The WebExtensions bookmarks API lets an add-on interact with and manipulate the browser's bookmarking system. You can use it to bookmark pages, retrieve existing bookmarks, and edit, remove, and organize bookmarks.

To use this API, an add-on must request the "bookmarks" permission in its manifest.json file.

Types

bookmarks.BookmarkTreeNodeUnmodifiable
A String enum which specifies why a bookmark or folder is unmodifiable.
bookmarks.BookmarkTreeNode
Represents a bookmark or folder in the bookmarks tree.
bookmarks.CreateDetails
Contains information which is passed to the bookmarks.create() function when creating a new bookmark.

Functions

bookmarks.create()
Creates a bookmark or folder.
bookmarks.get()
Retrieves one or more BookmarkTreeNodes, given a bookmark's ID or an array of bookmark IDs.
bookmarks.getChildren()
Retrieves the children of the specified BookmarkTreeNode.
bookmarks.getRecent()
Retrieves a requested number of recently added bookmarks.
bookmarks.getSubTree()
Retrieves part of the bookmarks tree, starting at the specified node.
bookmarks.getTree()
Retrieves the entire bookmarks tree into an array of BookmarkTreeNode objects.
bookmarks.move()
Moves the specified BookmarkTreeNode to a new location in the bookmark tree.
bookmarks.remove()
Removes a bookmark or an empty bookmark folder, given the node's ID.
bookmarks.removeTree()
Recursively removes a bookmark folder; that is, given the ID of a folder node, removes that node and all its descendants.
bookmarks.search()
Searches for BookmarkTreeNodes matching a specified set of criteria.
bookmarks.update()
Updates the title and/or URL of a bookmark, or the name of a bookmark folder, given the bookmark's ID.

Events

bookmarks.onCreated
Fired when a bookmark or folder is created.
bookmarks.onRemoved
Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.
bookmarks.onChanged
Fired when a bookmark or folder changes. Currently, only title and url changes trigger this.
bookmarks.onMoved
Fired when a bookmark or folder is moved to a different parent folder or to a new offset within its folder.
bookmarks.onChildrenReordered
Fired when the user has sorted the children of a folder in the browser's UI. This is not called as a result of a move().
bookmarks.onImportBegan
Fired when a bookmark import session is begun. Expensive observers should ignore bookmarks.onCreated updates until bookmarks.onImportEnded is fired. Observers should still handle other notifications immediately.
bookmarks.onImportEnded
Fired when a bookmark import session has finished.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
BookmarkTreeNodeYesNo45.0No33
BookmarkTreeNodeUnmodifiableYesNo45.0No33
CreateDetailsYesNo45.0No33
createYes1545.0No33
getYesNo45.0No33
getChildrenYesNo45.0No33
getRecentYesNo47.0No33
getSubTreeYesNo45.0No33
getTreeYes1545.0No33
moveYes1545.0No33
onChangedYesNo52.0No33
onChildrenReorderedYesNoNoNo33
onCreatedYesNo52.0No33
onImportBeganYesNoNoNo33
onImportEndedYesNoNoNo33
onMovedYesNo52.0No33
onRemovedYesNo52.0No33
removeYes1545.0No33
removeTreeYes1547.0No33
searchYesNo47.0No33
updateYes1545.0No33

Chrome incompatibilities

None.

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Sheppy, evilpie
 Last updated by: wbamberg,