跳至主要内容

剪贴板

读取和写入系统剪贴板。

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.

参数

名称类型
textstring

返回: Promise<void>

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