剪贴板

GitHub npm crates.io

API 参考

使用剪贴板插件读写系统剪贴板。

支持的平台

此插件需要 Rust 版本至少为 **1.77.2**

平台	级别	备注
Windows
Linux
macOS
Android		仅支持纯文本内容
iOS		仅支持纯文本内容

设置

安装剪贴板插件即可开始。

自动

使用你的项目包管理器添加依赖项

npm

npm run tauri add clipboard-manager

yarn

yarn run tauri add clipboard-manager

pnpm

pnpm tauri add clipboard-manager

deno

deno task tauri add clipboard-manager

bun

bun tauri add clipboard-manager

cargo

cargo tauri add clipboard-manager

手动

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到项目的 Cargo.toml 依赖项中

   cargo add tauri-plugin-clipboard-manager

2. 修改 lib.rs 以初始化插件

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .plugin(tauri_plugin_clipboard_manager::init())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. 如果您想在 JavaScript 中管理剪贴板，也请安装 npm 包

   npm

   npm install @tauri-apps/plugin-clipboard-manager

   yarn

   yarn add @tauri-apps/plugin-clipboard-manager

   pnpm

   pnpm add @tauri-apps/plugin-clipboard-manager

   deno

   deno add npm:@tauri-apps/plugin-clipboard-manager

   bun

   bun add @tauri-apps/plugin-clipboard-manager

用法

剪贴板插件在 JavaScript 和 Rust 中都可用。

JavaScript

import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';
// when using `"withGlobalTauri": true`, you may use
// const { writeText, readText } = window.__TAURI__.clipboardManager;

// Write content to clipboard
await writeText('Tauri is awesome!');

// Read content from clipboard
const content = await readText();
console.log(content);
// Prints "Tauri is awesome!" to the console

Rust

use tauri_plugin_clipboard_manager::ClipboardExt;

app.clipboard().write_text("Tauri is awesome!".to_string()).unwrap();

// Read content from clipboard
let content = app.clipboard().read_text();
println!("{:?}", content.unwrap());
// Prints "Tauri is awesome!" to the terminal

默认权限

默认情况下不启用任何功能，因为我们认为剪贴板本质上是危险的，并且是否需要读写访问是应用程序特定的。

剪贴板交互需要明确启用。

权限表

标识符	描述
clipboard-manager:allow-clear	允许清除命令，不带任何预配置范围。
clipboard-manager:deny-clear	拒绝清除命令，不带任何预配置范围。
clipboard-manager:allow-read-image	允许读取图像命令，不带任何预配置范围。
clipboard-manager:deny-read-image	拒绝读取图像命令，不带任何预配置范围。
clipboard-manager:allow-read-text	允许读取文本命令，不带任何预配置范围。
clipboard-manager:deny-read-text	拒绝读取文本命令，不带任何预配置范围。
clipboard-manager:allow-write-html	允许写入 HTML 命令，不带任何预配置范围。
clipboard-manager:deny-write-html	拒绝写入 HTML 命令，不带任何预配置范围。
clipboard-manager:allow-write-image	允许写入图像命令，不带任何预配置范围。
clipboard-manager:deny-write-image	拒绝写入图像命令，不带任何预配置范围。
clipboard-manager:allow-write-text	允许写入文本命令，不带任何预配置范围。
clipboard-manager:deny-write-text	拒绝写入文本命令，不带任何预配置范围。