剪贴板

读取和写入系统剪贴板。

当 tauri.conf.json 中的 build.withGlobalTauri 设置为 true 时，也可以通过 window.__TAURI__.clipboard 访问此软件包。

必须将 API 添加到 tauri.conf.json 中的 tauri.allowlist.clipboard

{
  "tauri": {
    "allowlist": {
      "clipboard": {
        "all": true, // enable all Clipboard APIs
        "writeText": true,
        "readText": true
      }
    }
  }
}

建议仅允许列出你为了优化包大小和安全性而使用的 API。

函数

readText

readText(): Promise<string | null>

以纯文本形式获取剪贴板内容。

示例

import { readText } from '@tauri-apps/api/clipboard';
const clipboardText = await readText();

自: 1.0.0.

返回：Promise<string | null>

writeText

writeText(text: string): Promise<void>

将纯文本写入剪贴板。

示例

import { writeText, readText } from '@tauri-apps/api/clipboard';
await writeText('Tauri is awesome!');
assert(await readText(), 'Tauri is awesome!');

自: 1.0.0.

参数

名称	类型
text	string

返回：Promise<void>

指示操作成功或失败的 Promise。