bookmarks

The WebExtensions bookmarks API lets an extension 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 extension must request the "bookmarks" permission in its manifest.json file.

Extensions cannot create, modify, or delete bookmarks in the root node of the bookmarks tree. Doing so causes an error with the message: "The bookmark root cannot be modified"

Types

bookmarks.BookmarkTreeNode

Represents a bookmark or folder in the bookmarks tree.

bookmarks.BookmarkTreeNodeType

A String enum which describes whether a node in the tree is a bookmark, a folder, or a separator.

bookmarks.BookmarkTreeNodeUnmodifiable

A String enum which specifies why a bookmark or folder is unmodifiable.

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

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	WebView Android	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet
BookmarkTreeNode	Yes	79	45	?	Yes	No	?	?	No	?	?	?
BookmarkTreeNodeType	No	No	57	?	No	No	?	?	No	?	?	?
BookmarkTreeNodeUnmodifiable	Yes	79	45	?	Yes	No	?	?	No	?	?	?
CreateDetails	Yes	79	45	?	Yes	No	?	?	No	?	?	?
create	Yes	15	45	?	Yes	No	?	?	No	?	?	?
get	Yes	79	45	?	Yes	No	?	?	No	?	?	?
getChildren	Yes	79	45	?	Yes	No	?	?	No	?	?	?
getRecent	Yes	79	47	?	Yes	No	?	?	No	?	?	?
getSubTree	Yes	79	45	?	Yes	No	?	?	No	?	?	?
getTree	Yes	15	45	?	Yes	No	?	?	No	?	?	?
move	Yes	15	45	?	Yes	No	?	?	No	?	?	?
onChanged	Yes	79	52	?	Yes	No	?	?	No	?	?	?
onChildrenReordered	Yes	79	No	?	Yes	No	?	?	No	?	?	?
onCreated	Yes	79	52	?	Yes	No	?	?	No	?	?	?
onImportBegan	Yes	79	No	?	Yes	No	?	?	No	?	?	?
onImportEnded	Yes	79	No	?	Yes	No	?	?	No	?	?	?
onMoved	Yes	79	52	?	Yes	No	?	?	No	?	?	?
onRemoved	Yes	79	52	?	Yes	No	?	?	No	?	?	?
remove	Yes	15	45	?	Yes	No	?	?	No	?	?	?
removeTree	Yes	15	47	?	Yes	No	?	?	No	?	?	?
search	Yes	79	47	?	Yes	No	?	?	No	?	?	?
update	Yes	15	45	?	Yes	No	?	?	No	?	?	?

Example extensions

• bookmark-it