关于javascript:通过js复制文本-js操作剪切板

2次阅读

共计 6155 个字符,预计需要花费 16 分钟才能阅读完成。

2022 更新最新兼容办法
具体参考如下:对于应用 js 复制到剪切板的兼容性写法 https://blog.csdn.net/qq_4530…

2021 年 12 月 08 日 更新三种办法

简介
目前,一共有三种办法能够实现剪贴板操作。

  1. Document.execCommand()办法
  2. 异步的 Clipboard API
  3. 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');

下面示例中,脚本先选中输入框 inputElement 外面的文字(inputElement.select()),而后 document.execCommand(‘copy’)将其复制到剪贴板。

留神,复制操作最好放在事件监听函数外面,由用户触发(比方用户点击按钮)。如果脚本自主执行,某些浏览器可能会报错。

(2)粘贴操作

粘贴时,调用 document.execCommand(‘paste’),就会将剪贴板外面的内容,输入到以后的焦点元素中。

const pasteText = document.querySelector('#output');
pasteText.focus();
document.execCommand('paste');

(3)毛病

Document.execCommand()办法尽管不便,然而有一些毛病。

首先,它只能将选中的内容复制到剪贴板,无奈向剪贴板任意写入内容。

其次,它是同步操作,如果复制 / 粘贴大量数据,页面会呈现卡顿。有些浏览器还会跳出提示框,要求用户许可,这时在用户做出抉择前,页面会失去响应。

为了解决这些问题,浏览器厂商提出了异步的 Clipboard API。

二、异步 Clipboard API
Clipboard API 是下一代的剪贴板操作方法,比传统的 document.execCommand()办法更弱小、更正当。

它的所有操作都是异步的,返回 Promise 对象,不会造成页面卡顿。而且,它能够将任意内容(比方图片)放入剪贴板。

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

const clipboardObj = navigator.clipboard;

如果 navigator.clipboard 属性返回 undefined,就阐明以后浏览器不反对这个 API。

因为用户可能把敏感数据(比方明码)放在剪贴板,容许脚本任意读取会产生平安危险,所以这个 API 的平安限度比拟多。

首先,Chrome 浏览器规定,只有 HTTPS 协定的页面能力应用这个 API。不过,开发环境(localhost)容许应用非加密协议。

其次,调用时须要明确取得用户的许可。权限的具体实现应用了 Permissions API,跟剪贴板相干的有两个权限:clipboard-write(写权限)和 clipboard-read(读权限)。
“ 写权限 ” 主动授予脚本,而 ” 读权限 ” 必须用户明确批准给予。

也就是说,写入剪贴板,脚本能够主动实现,然而读取剪贴板时,浏览器会弹出一个对话框,询问用户是否批准读取。

另外,须要留神的是,脚本读取的总是以后页面的剪贴板。这带来的一个问题是,如果把相干的代码粘贴到开发者工具中间接运行,可能会报错,因为这时的以后页面是开发者工具的窗口,而不是网页页面。

(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 对象
Clipboard 对象提供了四个办法,用来读写剪贴板。它们都是异步办法,返回 Promise 对象。

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()办法用于复制剪贴板外面的数据,能够是文本数据,也能够是二进制数据(比方图片)。该办法须要用户明确给予许可。

该办法返回一个 Promise 对象。一旦该对象的状态变为 resolved,就能够取得一个数组,每个数组成员都是 ClipboardItem 对象的实例。


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()
Clipboard.writeText()办法用于将文本内容写入剪贴板。

document.body.addEventListener(‘click’,
async (e) => {await navigator.clipboard.writeText(‘Yo’)
}
)

下面示例是用户在网页点击后,脚本向剪贴板写入文本数据。

该办法不须要用户许可,然而最好也放在 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 实例作为参数,示意写入剪贴板的数据。

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);
}

下面示例中,脚本向剪贴板写入了一张图片。留神,Chrome 浏览器目前只反对写入 PNG 格局的图片。

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

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

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);
}
});

下面示例中,先应用 e.preventDefault()勾销了剪贴板的默认操作,而后由脚本接管复制操作。

cut 事件则是在用户进行剪切操作时触发,它的解决跟 copy 事件齐全一样,也是从 Event.clipboardData 属性拿到剪切的数据。

六、paste 事件
用户应用剪贴板数据,进行粘贴操作时,会触发 paste 事件。

上面的示例是拦挡粘贴操作,由脚本将剪贴板外面的数据取出来。

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

一、原理:
利用 input 框的 .select() 事件选中须要复制的文本。
利用 document.execCommand(“copy”) 来将文字复制到剪切板中。【MDN 已废除, 局部浏览器可应用】代替计划:https://developer.mozilla.org/zh-CN/docs/Web/API/Clipboard_API
二、查阅材料

const copyText = document.getElementById('copyText')
copyText.select()
document.execCommand("copy"); // 执行浏览器复制命令

————————————————
版权申明:本文为 CSDN 博主「X.Py」的原创文章,遵循 CC 4.0 BY-SA 版权协定,转载请附上原文出处链接及本申明。
原文链接:https://blog.csdn.net/qq_4530…

正文完
 0