ClipboardItem

草案
此页面不完整。

ClipboardItem interface of the Clipboard API represents a single item format, used when reading or writing data via the Clipboard API . That is clipboard.read() and clipboard.write() 分别。

The benefit of having the ClipboardItem interface to represent data, is that it enables developers to cope with the varying scope of file types and data easily.

Access to the contents of the clipboard is gated behind the 权限 API : The clipboard-write permission is granted automatically to pages when they are in the active tab. The clipboard-read permission must be requested, which you can do by trying to read data from the clipboard.

注意 : To work with text see the Clipboard.readText() and Clipboard.writeText() methods of the Clipboard 接口。

注意 : You can only pass in one clipboard item at a time.

构造函数

ClipboardItem.ClipboardItem()
创建新的 ClipboardItem object, with the MIME type as the key and Blob as the value

特性

This interface provides the following properties.

types 只读
Returns an Array of MIME types available within the ClipboardItem .

方法

This interface defines the following methods.

getType()
返回 Promise that resolves with a Blob of the requested MIME type , or an error if the MIME type is not found.

范例

Writing To Clipboard

Here we're writing a new ClipboardItem.ClipboardItem() clipboard by requesting a png image using the 抓取 API , and in turn, the responses' blob() method, to create the new ClipboardItem .

async function writeClipImg() {
  try {
    const imgURL = '/myimage.png';
    const data = await fetch(imgURL);
    const blob = await data.blob();
    await navigator.clipboard.write([
      new ClipboardItem({
        [blob.type]: blob
      })
    ]);
    console.log('Fetched image copied.');
  } catch(err) {
    console.error(err.name, err.message);
  }
}
					

Reading From The Clipboard

Here we're returning all items on the clipboard via the clipboard.read() method. Then utilizing the ClipboardItem.types property to set the getType() argument and return the corresponding blob object.

async function getClipboardContents() {
  try {
    const clipboardItems = await navigator.clipboard.read();
    for (const clipboardItem of clipboardItems) {
      for (const type of clipboardItem.types) {
        const blob = await clipboardItem.getType(type);
        // we can now use blob here
      }
    }
  } catch (err) {
    console.error(err.name, err.message);
  }
}
					

规范

规范 状态 Comment
Clipboard API and events
The definition of 'ClipboardItem' in that specification.
工作草案 初始定义。

浏览器兼容性

更新 GitHub 上的兼容性数据
Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet
ClipboardItem
Chrome 66 Edge ≤79 Firefox No IE No Opera Yes Safari No WebView Android 66 Chrome Android 66 Firefox Android No Opera Android Yes Safari iOS No Samsung Internet Android Yes
ClipboardItem() 构造函数
Chrome 66 Edge ≤79 Firefox No IE No Opera Yes Safari No WebView Android 66 Chrome Android 66 Firefox Android No Opera Android Yes Safari iOS No Samsung Internet Android Yes
getType
Chrome 66 Edge ≤79 Firefox No IE No Opera Yes Safari No WebView Android 66 Chrome Android 66 Firefox Android No Opera Android Yes Safari iOS No Samsung Internet Android Yes
types
Chrome 66 Edge ≤79 Firefox No IE No Opera Yes Safari No WebView Android 66 Chrome Android 66 Firefox Android No Opera Android Yes Safari iOS No Samsung Internet Android Yes

图例

完整支持
完整支持
不支持
不支持
实验。期望将来行为有所改变。
实验。期望将来行为有所改变。

注意 : Image format support varies by browser. See the browser compatibility table for the Clipboard 接口。

另请参阅