@tauri-apps/plugin-clipboard-manager

讀取和寫入系統剪貼簿。

函式

clear()

function clear(): Promise<void>

清除剪貼簿。

平台特定

• Android： 僅在 SDK 28+ 上支援。對於較舊的版本，我們會改為將空字串寫入剪貼簿。

回傳

Promise<void>

範例

import { clear } from '@tauri-apps/plugin-clipboard-manager';
await clear();

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L147

---

readImage()

function readImage(): Promise<Image>

以 Uint8Array 影像取得剪貼簿內容。

平台特定

• Android / iOS： 不支援。

回傳

Promise<Image>

範例

import { readImage } from '@tauri-apps/plugin-clipboard-manager';

const clipboardImage = await readImage();
const blob = new Blob([await clipboardImage.rbga()], { type: 'image' })
const url = URL.createObjectURL(blob)

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L99

---

readText()

function readText(): Promise<string>

以純文字取得剪貼簿內容。

回傳

Promise<string>

範例

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

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L46

---

writeHtml()

function writeHtml(html, altText?): Promise<void>

• 將 HTML 寫入剪貼簿，或回退寫入提供的純文字。

平台特定

• Android / iOS： 不支援。

參數

參數	類型
html	string
altText?	string

回傳

Promise<void>

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

範例

import { writeHtml } from '@tauri-apps/plugin-clipboard-manager';
await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
// The following will write "<h1>Tauri is awesome</h1>" as plain text
await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>');
// we can read html data only as a string so there's just readText(), no readHtml()
assert(await readText(), '<h1>Tauri is awesome!</h1>');

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L126

---

writeImage()

function writeImage(image): Promise<void>

將影像緩衝區寫入剪貼簿。

平台特定

• Android / iOS： 不支援。

參數

參數	類型
image	| string | number[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | Image

回傳

Promise<void>

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

範例

import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
const buffer = [
  // A red pixel
  255, 0, 0, 255,

 // A green pixel
  0, 255, 0, 255,
];
await writeImage(buffer);

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L74

---

writeText()

function writeText(text, opts?): Promise<void>

將純文字寫入剪貼簿。

參數

參數	類型
text	string
opts?	object
opts.label?	string

回傳

Promise<void>

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

範例

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

自從

2.0.0

來源：https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L27