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

Chrome Edge Firefox Firefox for Android Opera
BookmarkTreeNode Yes No 45.0 No 33
BookmarkTreeNodeUnmodifiable Yes No 45.0 No 33
CreateDetails Yes No 45.0 No 33
create Yes No 45.0 No 33
export Yes No No No 33
get Yes No 45.0 No 33
getChildren Yes No 45.0 No 33
getRecent Yes No 47.0 No 33
getSubTree Yes No 45.0 No 33
getTree Yes No 45.0 No 33
import Yes No No No 33
move Yes No 45.0 No 33
onChanged Yes No No No 33
onChildrenReordered Yes No No No 33
onCreated Yes No No No 33
onImportBegan Yes No No No 33
onImportEnded Yes No No No 33
onMoved Yes No No No 33
onRemoved Yes No No No 33
remove Yes No 45.0 No 33
removeTree Yes No 47.0 No 33
search Yes No 47.0 No 33
update Yes No 45.0 No 33

Chrome incompatibilities

  • Firefox does not support:
    • import()
    • export()
    • onCreated
    • onRemoved
    • onChanged
    • onMoved
    • onChildrenReordered
    • onImportBegan
    • onImportEnded
    • BookmarkTreeNodeUnmodifiable
  • Firefox has special bookmarks like "Recently Bookmarked" or "Recently Visited"

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,