Clipboard（クリップボード）

《訳注》

Plugin 説明内容の英語表記部分について　Plugin の各章は、原文データからページ内容の一部が自動生成されているため、英語表記のままの部分があります。

GitHub npm crates.io

API Reference

「clipboard（クリップボード）」プラグインを使用してシステム・クリップボードの読み取りと書き込みを行ないます。

対応プラットフォーム

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

セットアップ

はじめに、「clipboard（クリップボード）」プラグインをインストールしてください。

自動で設定

自分のプロジェクトのパッケージ・マネージャーを使用して依存関係を追加します：

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

使用法

「clipboard」プラグインは、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.

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.

【※ この日本語版は、「Feb 22, 2025 英語版」に基づいています】