Clipboard

GitHub npm crates.io

API Reference

Read and write to the system clipboard using the clipboard plugin.

Setup

Install the clipboard plugin to get started.

Automatic

Use your project’s package manager to add the dependency:

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

Manual

1. Run cargo add tauri-plugin-clipboard-manager to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

   lib.rs

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

3. If you’d like to manage the clipboard in JavaScript then install the npm package as well:

   npm

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

   yarn

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

   pnpm

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

   bun

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

Usage

The clipboard plugin is available in both JavaScript and Rust.

JavaScript

import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';

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

// Write content to clipboard
let clipboard_content = tauri_plugin_clipboard_manager::ClipKind::PlainText {
    label: Some("Label".to_string()),
    text: "Tauri is awesome!".to_string(),
};
app.clipboard().write(clipboard_content).unwrap();

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