跳到主要内容
版本:v7

@capacitor/clipboard

Clipboard API 支持从系统剪贴板复制和粘贴数据。

安装

npm install @capacitor/clipboard@latest-7
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
WriteOptions

自版本: 1.0.0


read()

read() => Promise<ReadResult>

从剪贴板读取值(即“粘贴”操作)

返回值:

Promise<ReadResult>

自版本: 1.0.0


接口

WriteOptions

表示要写入剪贴板的数据。

属性类型描述自版本
stringstring要复制的文本值。1.0.0
imagestring要复制的图片,使用 Data URL 格式。1.0.0
urlstring要复制的 URL 字符串。1.0.0
labelstring伴随复制数据的用户可见标签(仅限 Android)。1.0.0

ReadResult

表示从剪贴板读取的数据。

属性类型描述自版本
valuestring从剪贴板读取的数据。1.0.0
typestring剪贴板中数据的类型。1.0.0