剪貼簿

GitHub npm crates.io

API 參考

使用剪貼簿外掛程式讀取和寫入系統剪貼簿。

支援平台

此外掛程式需要至少 1.77.2 的 Rust 版本

平台	層級	備註
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	啟用 clear 命令，而無需任何預先設定的範圍。
clipboard-manager:deny-clear	拒絕 clear 命令，而無需任何預先設定的範圍。
clipboard-manager:allow-read-image	啟用 read_image 命令，而無需任何預先設定的範圍。
clipboard-manager:deny-read-image	拒絕 read_image 命令，而無需任何預先設定的範圍。
clipboard-manager:allow-read-text	啟用 read_text 命令，而無需任何預先設定的範圍。
clipboard-manager:deny-read-text	拒絕 read_text 命令，而無需任何預先設定的範圍。
clipboard-manager:allow-write-html	啟用 write_html 命令，而無需任何預先設定的範圍。
clipboard-manager:deny-write-html	拒絕 write_html 命令，而無需任何預先設定的範圍。
clipboard-manager:allow-write-image	啟用 write_image 命令，而無需任何預先設定的範圍。
clipboard-manager:deny-write-image	拒絕 write_image 命令，而無需任何預先設定的範圍。
clipboard-manager:allow-write-text	啟用 write_text 命令，而無需任何預先設定的範圍。
clipboard-manager:deny-write-text	拒絕 write_text 命令，而無需任何預先設定的範圍。