@capacitor/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 | WriteOptions |
自 1.0.0
read()
read() => Promise<ReadResult>
从剪贴板读取值(“粘贴”操作)
**返回值:** Promise<ReadResult>
自 1.0.0
接口
WriteOptions
表示要写入剪贴板的数据。
属性 | 类型 | 描述 | 自 |
---|---|---|---|
string | string | 要复制的文本值。 | 1.0.0 |
image | string | 以 数据 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 |