@capacitor/clipboard
Clipboard API 实现了与系统剪贴板之间的复制粘贴功能。
安装
npm install @capacitor/clipboard
npx cap sync
示例
import { Clipboard } from '@capacitor/clipboard';
const writeToClipboard = async () => {
await Clipboard.write({
string: 'Hello World!',
});
};
const checkClipboard = async () => {
const { type, value } = await Clipboard.read();
console.log(`Got ${type} from clipboard: ${value}`);
};
API 文档
write(...)
write(options: WriteOptions) => Promise<void>
向剪贴板写入值("复制"操作)
参数 | 类型 |
---|---|
options |
|
自版本: 1.0.0
read()
read() => Promise<ReadResult>
从剪贴板读取值("粘贴"操作)
返回值:
Promise<ReadResult>
自版本: 1.0.0
Interfaces
WriteOptions
表示要写入剪贴板的数据。
属性 | 类型 | 描述 | 版本 |
---|---|---|---|
string | string | 要复制的文本值 | 1.0.0 |
image | string | 要复制的图片数据(Data URL 格式) | 1.0.0 |
url | string | 要复制的URL字符串 | 1.0.0 |
label | string | 伴随复制数据的用户可见标签(仅限Android) | 1.0.0 |
ReadResult
表示从剪贴板读取的数据。
属性 | 类型 | 描述 | 版本 |
---|---|---|---|
value | string | 从剪贴板读取的数据 | 1.0.0 |
type ] | string | 剪贴板中数据的类型 | 1.0.0 |