DataTransferItemList: add() 方法

Baseline 已广泛支持

此功能已得到良好确立,并在许多设备和浏览器版本中都可使用。自 ⁨2016 年 11 月⁩以来,它已在所有浏览器中可用。

DataTransferItemList.add() 方法使用指定的数据创建一个新的 DataTransferItem,并将其添加到拖动数据列表中。该项可以是 File 对象或给定类型的字符串。如果该项成功添加到列表中,则返回新创建的 DataTransferItem 对象。

语法

js
add(data, type)
add(file)

参数

data

表示拖动项数据的字符串。

type

表示拖动项类型的字符串。一些示例类型包括 text/htmltext/plain

文件

一个 File 对象。在这种情况下无需提供类型。

返回值

包含指定数据的 DataTransferItem。如果无法创建拖动项(例如,如果关联的 DataTransfer 对象没有数据存储),则返回 null

异常

NotSupportedError DOMException

如果提供了字符串 data 参数,并且列表中已包含一个 kind"Plain Unicode string" 且类型等于指定类型参数的项,则抛出此异常。

示例

此示例展示了 add() 方法的使用。

HTML

html
<div>
  <p id="source" draggable="true">
    Select this element, drag it to the Drop Zone and then release the selection
    to move the element.
  </p>
</div>
<div id="target">Drop Zone</div>

CSS

css
div {
  margin: 0em;
  padding: 2em;
}
#source {
  color: blue;
  border: 1px solid black;
}
#target {
  border: 1px solid black;
}

JavaScript

js
const source = document.getElementById("source");
const target = document.getElementById("target");

source.addEventListener("dragstart", (ev) => {
  console.log("dragStart");
  // Add this element's id to the drag payload so the drop handler will
  // know which element to add to its tree
  const dataList = ev.dataTransfer.items;
  dataList.add(ev.target.id, "text/plain");
  // Add some other items to the drag payload
  dataList.add("<p>Paragraph…</p>", "text/html");
  dataList.add("http://www.example.org", "text/uri-list");
});

source.addEventListener("dragend", (ev) => {
  console.log("dragEnd");
  const dataList = ev.dataTransfer.items;
  for (let i = 0; i < dataList.length; i++) {
    dataList.remove(i);
  }
  // Clear any remaining drag data
  dataList.clear();
});

target.addEventListener("drop", (ev) => {
  console.log("Drop");
  ev.preventDefault();
  // Loop through the dropped items and log their data
  for (const item of event.dataTransfer.items) {
    if (item.kind === "string" && item.type.match("^text/plain")) {
      // This item is the target node
      item.getAsString((s) => {
        ev.target.appendChild(document.getElementById(s));
      });
    } else if (item.kind === "string" && item.type.match("^text/html")) {
      // Drag data item is HTML
      item.getAsString((s) => {
        console.log(`… Drop: HTML = ${s}`);
      });
    } else if (item.kind === "string" && item.type.match("^text/uri-list")) {
      // Drag data item is URI
      item.getAsString((s) => {
        console.log(`… Drop: URI = ${s}`);
      });
    }
  }
});

target.addEventListener("dragover", (ev) => {
  console.log("dragOver");
  ev.preventDefault();
  // Set the dropEffect to move
  ev.dataTransfer.dropEffect = "move";
});

结果

规范

规范
HTML
# dom-datatransferitemlist-add-dev

浏览器兼容性