execCommand、clipboard方法实现 JS复制内容到剪切板

炎火师
3,462 阅读7分钟

一、简介

浏览器允许 JavaScript 脚本读写剪贴板，自动复制或粘贴内容。

一般来说，脚本不应该改动用户的剪贴板，以免不符合用户的预期。但是，有些时候这样做确实能够带来方便，比如"一键复制"功能，用户点击一下按钮，指定的内容就自动进入剪贴板。

目前，一共有三种方法可以实现剪贴板操作。

  • Document.execCommand()方法
  • 异步的 Clipboard API
  • copy事件和paste事件

二、Document.execCommand()方法

==Document.execCommand()== 是操作剪贴板的传统方法，各种浏览器都支持。

它支持复制、剪切和粘贴这三个操作。

document.execCommand('copy')（复制）
document.execCommand('cut')（剪切）
document.execCommand('paste')（粘贴）
(1)复制操作

复制时，先选中文本，然后调用==document.execCommand('copy')==，选中的文本就会进入剪贴板。

const inputElement = document.querySelector('#input');
inputElement.select();
document.execCommand('copy');
  • 注意，复制操作最好放在事件监听函数里面，由用户触发（比如用户点击按钮）。如果脚本自主执行，某些浏览器可能会报错。
(2)粘贴操作

粘贴时，调用==document.execCommand('paste')==，就会将剪贴板里面的内容，输出到当前的焦点元素中。

const pasteText = document.querySelector('#output');
pasteText.focus();
document.execCommand('paste');
(3)缺点
  • 只能将选中的内容复制到剪贴板，无法向剪贴板任意写入内容。
  • 其次，它是同步操作，如果复制/粘贴大量数据，页面会出现卡顿。有些浏览器还会跳出提示框，要求用户许可，这时在用户做出选择前，页面会失去响应。
  • 在PC端，可以复制文件和图片，但在移动端，无法复制图片

三、异步 Clipboard API

Clipboard API 是下一代的剪贴板操作方法，比传统的document.execCommand()方法更强大、更合理。

它的所有操作都是异步的，返回 Promise 对象，不会造成页面卡顿。而且，它可以将任意内容（比如图片）放入剪贴板。

==navigator.clipboard==属性返回 Clipboard 对象，所有操作都通过这个对象进行。

const clipboardObj = navigator.clipboard;
  • 如果==navigator.clipboard==属性返回==undefined==，就说明当前浏览器不支持这个 API。
  • 只有 HTTPS 协议的页面才能使用这个 API。不过，开发环境（localhost）允许使用非加密协议。
  • 其次，调用时需要明确获得用户的许可。权限的具体实现使用了 Permissions API，跟剪贴板相关的有两个权限：clipboard-write（写权限）和clipboard-read（读权限）。"写权限"自动授予脚本，而"读权限"必须用户明确同意给予。也就是说，写入剪贴板，脚本可以自动完成，但是读取剪贴板时，浏览器会弹出一个对话框，询问用户是否同意读取。

image

脚本读取的总是当前页面的剪贴板。这带来的一个问题是，如果把相关的代码粘贴到开发者工具中直接运行，可能会报错，因为这时的当前页面是开发者工具的窗口，而不是网页页面。

(async () => {
  const text = await navigator.clipboard.readText();
  console.log(text);
})();

如果你把上面的代码，粘贴到开发者工具里面运行，就会报错。因为代码运行的时候，开发者工具窗口是当前页，这个页面不存在 Clipboard API 依赖的 DOM 接口。一个解决方法就是，相关代码放到setTimeout()里面延迟运行，在调用函数之前快速点击浏览器的页面窗口，将其变成当前页。

setTimeout(async () => {
  const text = await navigator.clipboard.readText();
  console.log(text);
}, 2000);

上面代码粘贴到开发者工具运行后，快速点击一下网页的页面窗口，使其变为当前页，这样就不会报错了。

四、异步 Clipboard API

4.1 Clipboard.readText()

==Clipboard.readText()== 方法用于复制剪贴板里面的文本数据。

document.body.addEventListener(
  'click',
  async (e) => {
    const text = await navigator.clipboard.readText();
    console.log(text);
  }
)

上面示例中，用户点击页面后，就会输出剪贴板里面的文本。注意，浏览器这时会跳出一个对话框，询问用户是否同意脚本读取剪贴板。

如果用户不同意，脚本就会报错。这时，可以使用try...catch结构，处理报错。

async function getClipboardContents() {
  try {
    const text = await navigator.clipboard.readText();
    console.log('Pasted content: ', text);
  } catch (err) {
    console.error('Failed to read clipboard contents: ', err);
  }
}
4.2 Clipboard.read()

==Clipboard.read()== 方法用于复制剪贴板里面的数据，可以是文本数据，也可以是二进制数据（比如图片）。该方法需要用户明确给予许可。

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);
        console.log(URL.createObjectURL(blob));
      }
    }
  } catch (err) {
    console.error(err.name, err.message);
  }
}

ClipboardItem 对象表示一个单独的剪贴项，每个剪贴项都拥有==ClipboardItem.types==属性和==ClipboardItem.getType()== 方法。

  • ==ClipboardItem.types==属性返回一个数组，里面的成员是该剪贴项可用的 MIME 类型，比如某个剪贴项可以用 HTML 格式粘贴，也可以用纯文本格式粘贴，那么它就有两个 MIME 类型（text/html和text/plain）。

  • ClipboardItem.getType(type)方法用于读取剪贴项的数据，返回一个 Promise 对象。该方法接受剪贴项的 MIME 类型作为参数，返回该类型的数据，该参数是必需的，否则会报错。

4.3 Clipboard.writeText()

用户在网页点击后，脚本向剪贴板写入文本数据。

该方法不需要用户许可，但是最好也放在try...catch里面防止报错。

async function copyPageUrl() {
  try {
    await navigator.clipboard.writeText(location.href);
    console.log('Page URL copied to clipboard');
  } catch (err) {
    console.error('Failed to copy: ', err);
  }
}
4.4 Clipboard.write()

Clipboard.write()方法用于将任意数据写入剪贴板，可以是文本数据，也可以是二进制数据。

该方法接受一个 ClipboardItem 实例作为参数，表示写入剪贴板的数据。

// 目前只支持写入 PNG 格式的图片
try {
  const imgURL = 'https://dummyimage.com/300.png';
  const data = await fetch(imgURL);
  const blob = await data.blob();
  await navigator.clipboard.write([
    new ClipboardItem({
      [blob.type]: blob
    })
  ]);
  console.log('Image copied.');
} catch (err) {
  console.error(err.name, err.message);
}

下面的例子是将同一个剪贴项的多种格式的值，写入剪贴板，一种是文本数据，另一种是二进制数据，供不同的场合粘贴使用。

function copy() {
  const image = await fetch('kitten.png');
  const text = new Blob(['Cute sleeping kitten'], {type: 'text/plain'});
  const item = new ClipboardItem({
    'text/plain': text,
    'image/png': image
  });
  await navigator.clipboard.write([item]);
}

五、copy 事件，cut 事件

  • 触发copy事件,示例是将用户放入剪贴板的文本，转为大写。
const source = document.querySelector('.source');

source.addEventListener('copy', (event) => {
  const selection = document.getSelection();
  event.clipboardData.setData('text/plain', selection.toString().toUpperCase());
  event.preventDefault();
});

上面示例中，事件对象的==clipboardData==属性包含了剪贴板数据。它是一个对象，有以下属性和方法。

Event.clipboardData.setData(type, data)：修改剪贴板数据，需要指定数据类型。
Event.clipboardData.getData(type)：获取剪贴板数据，需要指定数据类型。
Event.clipboardData.clearData([type])：清除剪贴板数据，可以指定数据类型。如果不指定类型，将清除所有类型的数据。
Event.clipboardData.items：一个类似数组的对象，包含了所有剪贴项，不过通常只有一个剪贴项。
  • 下面的示例是拦截用户的复制操作，将指定内容放入剪贴板。
const clipboardItems = [];

document.addEventListener('copy', async (e) => {
  e.preventDefault(); // 取消了剪贴板的默认操作
  try {
    let clipboardItems = [];
    for (const item of e.clipboardData.items) {
      if (!item.type.startsWith('image/')) {
        continue;
      }
      clipboardItems.push(
        new ClipboardItem({
          [item.type]: item,
        })
      );
      await navigator.clipboard.write(clipboardItems);
      console.log('Image copied.');
    }
  } catch (err) {
    console.error(err.name, err.message);
  }
});

六、paste 事件

进行粘贴操作时，会触发paste事件。

document.addEventListener('paste', async (e) => {
  e.preventDefault();
  const text = await navigator.clipboard.readText();
  console.log('Pasted text: ', text);
});

七、实战案例

1、clipboard 实战

// 转换成base64
function toBase64(img): string {
  const canvas = document.createElement('canvas');
  canvas.width = img.width;
  canvas.height = img.height;
  const ctx = canvas.getContext('2d');
  ctx?.drawImage(img, 0, 0, canvas.width, canvas.height);
  const base64 = canvas.toDataURL('image/png');
  return base64;
}

// url转换成png 格式的blob
function getImage64(url): any {
  const img = new Image();
  img.crossOrigin = 'anonymous';
  img.src = url;
  return new Promise((resolve, reject) => {
    img.onload = () => {
      const base64Data = toBase64(img);
      const blob = convertBase64ToBlob(base64Data, 'image/png');
      resolve(blob);
    };
  });
}

// 调用复制功能
async function copyImage(url) {
  try {
  if (！navigator.permissions || !navigator.permissions.query) {
      console.log('无权限')
      return
  }
  navigator.permissions.query({ name: 'clipboard-write' }).then(async (result) => {
    if (result.state === 'granted') {
        const imgURL = url || 'https://dummyimage.com/300.png';
        // const data = await fetch(imgURL);
        // const blob = await data.blob();
        const blob = await getImage64(imgURL);
        await navigator.clipboard.write([
          new ClipboardItem({
            [blob.type]: blob,
          }),
        ]);
        console.log('Image copied.');
      } catch (err) {
        console.error(err);
      }
    } else {
        console.log("clipboard-permissoin not granted: " + result);
    }
  });
}

2、execCommand 实战案例

function copyTextandImg(sets): Promise<void> {
  console.log(sets);
  return new Promise((resolve, reject) => {
    const imgDiv = document.createElement('div');
    imgDiv.id = '__imgDiv';
    imgDiv.setAttribute('style', 'z-index: -1;position: fixed;');
    let child = '';
    if (sets.txts) {
      if (typeof sets.txts === 'string') {
        child += `<span>${sets.txts}</span>`;
      } else {
        sets.txts.forEach((item) => {
          child += `<span>${item}</span>`;
        });
      }
    }
    if (sets.imgs) {
      if (typeof sets.imgs === 'string') {
        // sets.imgs = sets.imgs.indexOf('https') > -1 ? sets.imgs.replace('https', 'http') : sets.imgs;
        child += `<img src="${sets.imgs}" />`;
      } else {
        sets.imgs.forEach((item) => {
          // item = item.indexOf('https') > -1 ? item.replace('https', 'http') : item;
          child += `<img src="${item}" />`;
        });
      }
    }
    imgDiv.innerHTML = child;
    document.body.insertBefore(imgDiv, document.body.lastChild);
    const dom = document.getElementById('__imgDiv');
    if (dom) {
      if (window.getSelection) {
        //chrome等主流浏览器
        const selection = window.getSelection();
        const range = document.createRange();
        range.selectNodeContents(dom);
        selection && selection.removeAllRanges();
        selection && selection.addRange(range);
      } else if (document.body['createTextRange']) {
        //ie
        const range = (document.body as any).createTextRange();
        range.moveToElementText(dom);
        range.select();
      }
      // (window as any).clipboardData.setData("Text", "");
      document.execCommand('copy');
      (window as any).getSelection().removeAllRanges();
      (imgDiv?.parentNode as any).removeChild(imgDiv);
      resolve();
    } else {
      reject();
    }
  });
}

// 使用
const imgURL = 'https://dummyimage.com/300.png';
const text = '我是复制的内容';
copyTextandImg({
    imgs: [imgURL],
    txts: text,
}).then(() => {
    console.log('复制成功拉');
});

参考链接 阮一峰大佬的博客

avatar
文章
阅读
粉丝