js实现复制粘贴功能

1,094 阅读7分钟

方式一:原生方式实现复制粘贴剪切(不推荐)

使用浏览器自带的document.execCommand('copy')实现复制,document.execCommand('paste')实现粘贴,document.execCommand('cut')实现剪切,这三个方法的返回值是布尔类型,用来判断当前浏览器中能够使用这些方法,true表示方法能用,false表示方法不能用,目前因为document.execCommand('paste')涉及到安全问题,考虑到安全原因, document.execCommand(‘paste’)操作已经被禁止了。

补充说明下,目前官方已经不推荐使用原生方式进行复制粘贴操作了,这几种方法随时可能会被删掉

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
  </head>
  <body>
    <input type="text" id="input" value="123" />
    <button onclick="copy1()">复制(复制可编辑的标签中的内容)</button>
    <button onclick="copy2('这是复制的内容')">复制(将可编辑的标签隐藏)</button>
    <button onclick="cut()">剪切</button>
    <button onclick="paste()">粘贴</button>
    <input type="text" id="output">
    <script>
        // 复制可编辑标签中的value值得内容
      function copy1() {
        const inputEle = document.querySelector("#input");
        inputEle.select(); // 鼠标选择的内容
        document.execCommand("copy"); // 复制
      }

      /**
       * 如果想使用 execCommand 方法,又不想页面中出现可编辑区域,可以用下述办法取巧
       * @content 是要复制的内容
      */
      function copy2(content) {
        const dom = document.createElement("input");
        dom.value = content;
        document.body.appendChild(dom);
        dom.select();
        document.execCommand("copy");
        document.body.removeChild(dom);
      }

      // 剪切功能
      function cut(){
        console.log("cut");
        document.execCommand("cut")
      }

      // 粘贴功能:注意,只会在光标所在位置进行粘贴
      // function paste(){
      //   const pasteText = document.querySelector("#output")
      //   pasteText.focus() // 让光标聚焦到output标识的输入框上
      //   document.execCommand("paste"); // 截至目前该方法涉及到安全问题已失效
      // }
    </script>
  </body>
</html>

使用execCommand命令存在以下缺陷:

(1)不够灵活。只能操作input, textarea或具有contenteditable属性的元素

(2)execCommand是同步操作,如果复制/粘贴大量数据,页面会出现卡顿。

(3)有些浏览器还会跳出提示框,要求用户许可,这时在用户做出选择前,页面会失去响应。

(4)它只能将选中的内容复制到剪贴板,无法向剪贴板任意写入内容

方式二:浏览器自带clipboard API实现复制粘贴(推荐)

特点

(1)它的所有操作都是异步进行的,返回promise对象,不糊造成页面卡顿,

(2)它可以将任何内容(例如图片)放入到剪贴板。

(3)安全。通过navigator.clipboard属性返回Clipboard对象,所有操作都通过这个对象进行,如果navigator.clipboard属性返回undefined,就说明当前浏览器不支持这个API。

(4)有一点需要特别注意,脚本读取的是当前页面的剪切板(注意我说的是浏览器中的剪贴板,而不是电脑操作系统自带的剪贴板) ,这带来一个问题,如果想把相关的代码粘贴到开发者工具中直接运行,可能会报错,因为这时的当前页面是开发者工具的窗口,而不是网页页面。

例如:你把下面的代码粘贴到开发者工具运行就会报错。

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

因为在代码运行的时候,开发者工具窗口是当前页,这个页面不存在ClipboardAPI依赖的DOM接口。

解决办法是将相关代码放到setTimeout()里面延迟运行,在调用函数之前快速点击浏览器的页面窗口,将其变成当前页。

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

clipboard对象及相关API

clipboard对象提供了四个方法用来读写剪贴板,他们都是异步方法,返回promise对象。

1.Clipboard.readText()

Clipboard.readText()方法用来复制剪贴板也就是粘贴功能)里面的文本数据。

// 普通方法
function paste() {
  navigator.clipboard // 创建clipboard对象
    .readText() // 调用readText()方法
    .then((clipText) => {
      // 成功回调 
      console.log(clipText); // clipText是从剪贴板读取到的内容(也就是要粘贴的内容)
    })
    .catch((err) => console.log("粘贴失败!",err)); // 失败回调
}

2.Clipboard.read()

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

该方法返回一个 Promise 对象。一旦该对象的状态变为 resolved,就可以获得一个数组,每个数组成员都是 ClipboardItem 对象的实例

下面我们简单介绍下代码中用到的几个对象属性和方法 遍历通过Clipboard.read()方法成功回调得到的数组对象,由此得到一个个的ClipboardItem 对象,表示一个单独的剪贴项,每个剪贴项都拥有ClipboardItem.types属性和ClipboardItem.getType()方法。

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

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

// 粘贴任何类型的数据
function paste() {
  navigator.clipboard
    .read() // 调用read()方法从剪贴板读取数据进行粘贴操作
    .then((clipboardItems) => {
      console.log(clipboardItems,"clipboardItems =========");
      // clipboardItems是一个数组
      for (const clipboardItem of clipboardItems) {
        console.log(clipboardItem, "clipboardItem ========="); // clipboardItem是一个实例对象
        for (const type of clipboardItem.types) { // clipboardItem.types返回一个数组,存储的是每一段剪贴板的mine数据类型
          clipboardItem
            .getType(type) // 读取接收到的mine类型作为参数,返回该类型的数据
            .then((res) => console.log(res))
            .catch((err) => console.log(err));
        }
      }
    })
    .catch((err) => {
      console.log(err.name,err.message)
    });
}

//或者
async function paste(){
 try {
  const clipboardItems = await navigator.clipboard.read()
  for(const clipboardItem of clipboardItems){
    for(const type of clipboardItem.types){
      const result = await clipboardItem.getType(type)
      console.log(result);
    }
  }
 } catch (err) {
  console.log(err.name,err.message);
 }
}

3.Clipboard.writeText()

Clipboard.writeText()方法用于将文本内容写入剪贴板(也就是复制功能) ,该方法同样返回一个Promise对象。

document.body.addEventListener('click',async (e) => {
    await navigator.clipboard.writeText('Yo') // 参数是要写入的文本
  }
)

4.Clipboard.write()

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

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

async function copy1() {
  try {
  	// 图片地址
    const imgURL = "https://dummyimage.com/300.png"; 
    // 获取图片
    const data = await fetch(imgURL); 
    // 将图片转为blob类型
    const blob = await data.blob(); 
    // 将数据写入(复制)到剪贴板
    await navigator.clipboard.write([ 
      // 创建Clipboard实例对象,对象的键名是数据的 MIME 类型,键值就是数据本身
      new ClipboardItem({ 
        [blob.type]: blob,
      }),
    ]);
    console.log("Image copied.");
  } catch (err) {
    console.error(err.name, err.message);
  }
}

ClipboardItem()浏览器原生提供的构造函数,用来生成ClipboardItem实例,它接收一个对象作为参数,该对象的键名是数据的 MIME 类型,键值就是数据本身。

注意,Chrome 浏览器目前只支持写入 PNG 格式的图片。

此外,write()方法还可以将用一个剪贴项的多种格式的值写入到剪贴板,一种是文本数据,一种是二进制数据,供不同的场合粘贴使用。

function copy() {
  const image = await fetch('kitten.png'); // 获取图片类型的数据
  const blob = await image.blob(); // 将图片转为blob对象
  const text = new Blob(['Cute sleeping kitten'], {type: 'text/plain'}); // 获取文字类型的数据并转为blob实例对象
  const item = new ClipboardItem({
    'text/plain': text,
    [blob.type]: image
  });
  await navigator.clipboard.write([item]);
}

方式三:clipboard.js插件库实现复制剪切(推荐)

# node安装
npm install clipboard --save

封装到全局工具中 clipboard.js

import Vue from 'vue'
import Clipboard from 'clipboard'

function clipboardSuccess() {
  Vue.prototype.$message.success('复制成功')
}

function clipboardError() {
  Vue.prototype.$message.error('复制失败')
}

export default function handleClipboard(text, event) {
  const clipboard = new Clipboard(event.target, {
    text: () => text
  })
  clipboard.on('success', () => {
    clipboardSuccess()
    clipboard.destroy()
  })
  clipboard.on('error', () => {
    clipboardError()
    clipboard.destroy()
  })
  clipboard.onClick(event)
}

组件中使用

# template 模板代码
<el-table-column prop="webUrl" label="H5链接" width="300">
    <template slot-scope="scope">
      <el-link
        :underline="false"
        type="primary"
        @click="handleCopy(scope.row.webUrl, $event)"
      >{{ scope.row.webUrl }}
      </el-link>
    </template>
</el-table-column>

  
# 脚本代码
import clip from '@/utils/clipboard'
handleCopy(text, event) {
  clip(text, event)
}

注意 svg图片不能做为dom节点传进去,会报错:# First argument must be a String, HTMLElement, HTMLCollection, or NodeList vue2.0 clipboard 报错,因为svg 不属于HTMLElement  无法传入 cliboard实例中

四、vue-clipboard2插件

使用:
npm install --save vue-clipboard2
// main.ts中全局注册
import VueClipboard from 'vue-clipboard2';
Vue.use(VueClipboard);

// 页面中基本使用
<template>
  <div>
    <p>要复制的文本:{{ text }}</p>
    <button v-clipboard="text">复制</button>
  </div>
</template>

<script>
export default {
  data () {
    return {
      text: 'Hello, World!'
    }
  }
}
</script>


// 使用v-clipboard:copy
<template>
  <div>
    <p>要复制的文本:{{ text }}</p>
    <button v-clipboard:copy="handleCopy">复制</button>
  </div>
</template>

<script>
export default {
  data () {
    return {
      text: 'Hello, World!'
    }
  },
  methods: {
    handleCopy (text) {
      // 在文本前加上一行提示信息
      return '复制成功:\n' + text
    }
  }
}
</script>
// 使用v-clipboard:success指令
<template>
  <div>
    <p>要复制的文本:{{ text }}</p>
    <button v-clipboard="text" v-clipboard:success="handleSuccess">复制</button>
  </div>
</template>

<script>
export default {
  data () {
    return {
      text: 'Hello, World!'
    }
  },
  methods: {
    handleSuccess () {
      alert('复制成功!')
    }
  }
}
</script>

原文地址:blog.csdn.net/lalala_dxf/…