@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(...)
• read()
• Interfaces

write(...)

write(options: WriteOptions) => Promise<void>

向剪贴板写入一个值（"复制"操作）

参数	类型
options	WriteOptions

Since: 1.0.0

---

read()

read() => Promise<ReadResult>

从剪贴板读取一个值（"粘贴"操作）

返回:

Promise<ReadResult>

Since: 1.0.0

---

接口

WriteOptions

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

属性	类型	描述	Since
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

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

属性	类型	描述	Since
value	string	从剪贴板读取的数据。	1.0.0
type	string	剪贴板中数据的类型。	1.0.0