clipboard

读取和写入系统剪贴板

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>

一个表示操作成功或失败的承诺