@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.rgba()], { 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	字符串
altText?	字符串

返回

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

将纯文本写入剪贴板。

参数

参数	类型
文本	字符串
选项?	对象
opts.label?	字符串

返回

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