W3cubDocs

/Web Extensions

bookmarks.CreateDetails

The CreateDetails type is used to describe the properties of a new, bookmark, bookmark folder, or separator when calling the bookmarks.create() method.

Type

An object containing some combination of the following fields:

index Optional
An integer Number which specifies the position at which to place the new bookmark under its parent. A value of 0 will put it at the top of the list.
parentId Optional
A string which indicates the ID of the parent folder into which to place the new bookmark or bookmark folder. On Chrome and Firefox, the default is the "Other Bookmarks" folder on the Bookmarks menu.
title Optional
A string which specifies the title for the bookmark or the name of the folder to be created. If this isn't specified, the title is "".
typeOptional
A bookmarks.BookmarkTreeNodeType object indicating whether this is a bookmark, a folder, or a separator. Defaults to "bookmark" unless url is omitted, in which case it defaults to "folder".
url Optional
string. A string which specifies the URL of the page to bookmark. If this is omitted or is null, a folder is created instead of a bookmark.

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
CreateDetails
Yes
79
45
?
Yes
No
?
?
No
?
?
?
type
No
No
57
?
No
No
?
?
No
?
?
?

Note: 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.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks/CreateDetails