DataTransferItemList

Baseline 已广泛支持

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

DataTransferItemList 对象是 DataTransferItem 对象的列表,表示正在拖动的项。在拖动操作期间,每个 DragEvent 都有一个 dataTransfer 属性,该属性是 DataTransferItemList

可以使用 方括号表示法 [] 访问单个项。

DataTransferItemList 主要为 HTML 拖放 API 设计,并且仍然在 HTML 拖放部分进行指定,但现在也被其他 API 使用,例如 ClipboardEvent.clipboardDataInputEvent.dataTransferDataTransferItemList 的文档将主要讨论其在拖放操作中的用法,您应该参考其他 API 的文档以了解 DataTransferItemList 在这些上下文中的用法。

此接口没有构造函数。

实例属性

DataTransferItemList.length 只读

一个 unsigned long,表示列表中拖动项的数量。

实例方法

DataTransferItemList.add()

将一个项(可以是 File 对象或字符串)添加到拖动项列表中,并返回新项的 DataTransferItem 对象。

DataTransferItemList.remove()

从列表中删除指定索引处的拖动项。

DataTransferItemList.clear()

从列表中删除所有拖动项。

示例

此示例显示了如何使用拖放。

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;

  // 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 ev.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
# the-datatransferitemlist-interface

浏览器兼容性