剪切板

GitHub npm crates.io

API Reference

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

Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android		Only plain-text content support
ios		Only plain-text content support

设置

从安装剪贴板插件开始。

自动

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

npm

npm run tauri add clipboard-manager

yarn

yarn run tauri add clipboard-manager

pnpm

pnpm 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';
// 当设置 `"withGlobalTauri": true` 时, 你可以使用
// const { writeText, readText } = window.__TAURI__.clipboardManager;

// 将内容写到剪贴板
await writeText('Tauri is awesome!');

// 从剪贴板读取内容
const content = await readText();
console.log(content);
// 将 "Tauri is awesome!" 输出到控制台

Rust

use tauri_plugin_clipboard_manager::ClipboardExt;

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

// 从剪贴板读取内容
let content = app.clipboard().read_text();
println!("{:?}", content.unwrap());
// 将 "Tauri is awesome!" 输出到终端

Default Permission

No features are enabled by default, as we believe the clipboard can be inherently dangerous and it is application specific if read and/or write access is needed.

Clipboard interaction needs to be explicitly enabled.

This default permission set includes the following:

Permission Table

Identifier	Description
clipboard-manager:allow-clear	Enables the clear command without any pre-configured scope.
clipboard-manager:deny-clear	Denies the clear command without any pre-configured scope.
clipboard-manager:allow-read-image	Enables the read_image command without any pre-configured scope.
clipboard-manager:deny-read-image	Denies the read_image command without any pre-configured scope.
clipboard-manager:allow-read-text	Enables the read_text command without any pre-configured scope.
clipboard-manager:deny-read-text	Denies the read_text command without any pre-configured scope.
clipboard-manager:allow-write-html	Enables the write_html command without any pre-configured scope.
clipboard-manager:deny-write-html	Denies the write_html command without any pre-configured scope.
clipboard-manager:allow-write-image	Enables the write_image command without any pre-configured scope.
clipboard-manager:deny-write-image	Denies the write_image command without any pre-configured scope.
clipboard-manager:allow-write-text	Enables the write_text command without any pre-configured scope.
clipboard-manager:deny-write-text	Denies the write_text command without any pre-configured scope.