bookmarks.create()

Creates a bookmark or folder as a child of the BookmarkTreeNode with the specified parentId. To create a folder, omit or leave empty the CreateDetails.url parameter.

This is an asynchronous function that returns a Promise.

Syntax

var createBookmark = browser.bookmarks.create(
  bookmark                  // CreateDetails object
)

Parameters

bookmark

An object containing some combination of the following fields:

parentId Optional

A string which indicates the parent folder into which to place the new bookmark or bookmark folder. Each browser has its own default; on Chrome, the default is the "Other Bookmarks" folder. On Firefox, the default is "Unfiled Bookmarks".

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.

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 "".

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.

Return value

A Promise that will be fulfilled with a BookmarkTreeNode that describes the new bookmark node.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Examples

This example creates a bookmark for this page, placing it in the default folder ("Unfiled Bookmarks" in Firefox, "Other Bookmarks" in Chrome).

function onCreated(node) {
  console.log(node);
}
var createBookmark = browser.bookmarks.create({
  title: "bookmarks.create() on MDN",
  url: "https://developer.mozilla.org/Add-ons/WebExtensions/API/bookmarks/create"
});
createBookmark.then(onCreated);

Example extensions

• bookmark-it

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.