剪貼簿

讀取和寫入系統剪貼簿。

當 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>

指示作業成功或失敗的承諾。