copy 剪贴板复制方法
一个轻量级的剪贴板复制工具函数,兼容主流浏览器及 IE11。
安装
bash
import copy from '@pt/utils/modules/clipboard'基础用法
ts
import copy from '@pt/utils/modules/clipboard';
// 复制文本
const success = copy('Hello World');
if (success) {
console.log('复制成功');
} else {
console.log('复制失败');
}API
copy(text, options?)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| text | string | 是 | 要复制的文本内容 |
| options | Options | 否 | 配置选项 |
返回值: boolean - 复制是否成功
Options 配置项
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| debug | boolean | false | 开启调试模式,输出错误日志 |
| message | string | 'Copy to clipboard: #{key}, Enter' | 降级提示信息,#{key} 会被替换为快捷键 |
| format | string | - | MIME 类型,如 'text/plain'、'text/html' |
| onCopy | (clipboardData: object) => void | - | 复制时的回调函数 |
示例
基础复制
ts
copy('要复制的内容');开启调试模式
ts
copy('debug text', { debug: true });指定 MIME 类型
ts
copy('<b>HTML内容</b>', { format: 'text/html' });监听复制事件
ts
copy('监听复制', {
onCopy: (clipboardData) => {
console.log('已复制到剪贴板', clipboardData);
},
});浏览器兼容性
- ✅ Chrome
- ✅ Firefox
- ✅ Safari
- ✅ Edge
- ✅ IE11 (降级支持)