bookmarks.move()

The bookmarks.move() method moves the specified BookmarkTreeNode to the specified destination within the tree of bookmarks. This lets you move a bookmark to a new folder and/or position within the folder.

Syntax

chrome.bookmarks.move(
  id,                    // string
  destination,           // object
  function(              // optional function
    result                 // BookmarkTreeNode object
  ) {...}
)

This API is also available as browser.bookmarks.move() in a version that returns a promise.

Parameters

id

A string containing the ID of the bookmark or folder to move.

destination

An object which specifies the destination for the bookmark. This object must contain one or both of the following fields:

parentId Optional

A string which specifies the ID of the destination folder. If this value is left out, the bookmark is moved to a new location within its current folder.

index Optional

A 0-based index specifying the position within the folder to which to move the bookmark. A value of 0 moves the bookmark to the top of the folder. If this value is omitted, the bookmark is placed at the end of the new parent folder.

callback Optional

A function which is called once the move operation is completed. It receives as input one parameter:

result

The updated BookmarkTreeNode describing the moved 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

Move a bookmark to the top of its folder

This example moves an existing bookmark so that it's the first bookmark in its current folder. It does so without using a callback, since it takes no further action.

chrome.bookmarks.move(bookmarkID, { index: 0 });

Move a bookmark to a different folder

This example shows how to write a function which, given a bookmark's ID and a folder ID, moves the bookmark into that folder. It also provides a callback which is run when the move is completed.

function moveToFolder(bookmarkId, destinationId) {
  chrome.bookmarks.move(bookmarkId, { parentId: destinationId },
                         function(updatedNode) {
    /* The bookmark has been moved */
  });
}

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