Portapapeles (Clipboard)

GitHubnpmcrates.io

Referencia de API

Lee y escribe en el portapapeles del sistema utilizando el plugin clipboard.

Plataformas Soportadas

Este plugin requiere una versión de Rust de al menos 1.77.2

Plataforma	Nivel	Notas
windows
linux
macos
android		Solo soporte para contenido de texto plano
ios		Solo soporte para contenido de texto plano

Configuración

Instala el plugin clipboard para comenzar.

Automático

Usa el gestor de paquetes de tu proyecto para agregar la dependencia:

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

Manual

1. Ejecuta el siguiente comando en la carpeta src-tauri para agregar el plugin a las dependencias del proyecto en Cargo.toml:

   cargo add tauri-plugin-clipboard-manager

2. Modifica lib.rs para inicializar el plugin:

   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. Si quieres gestionar el portapapeles en JavaScript, instala también el paquete 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

Uso

El plugin clipboard está disponible tanto en JavaScript como en 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

Permiso Predeterminado

Ninguna característica está habilitada de forma predeterminada, ya que creemos que el portapapeles puede ser intrínsecamente peligroso y depende de la aplicación si se necesita acceso de lectura y/o escritura.

La interacción con el portapapeles debe habilitarse explícitamente.

Tabla de Permisos

Identificador	Descripción
clipboard-manager:allow-clear	Habilita el comando clear sin ningún alcance preconfigurado.
clipboard-manager:deny-clear	Deniega el comando clear sin ningún alcance preconfigurado.
clipboard-manager:allow-read-image	Habilita el comando read_image sin ningún alcance preconfigurado.
clipboard-manager:deny-read-image	Deniega el comando read_image sin ningún alcance preconfigurado.
clipboard-manager:allow-read-text	Habilita el comando read_text sin ningún alcance preconfigurado.
clipboard-manager:deny-read-text	Deniega el comando read_text sin ningún alcance preconfigurado.
clipboard-manager:allow-write-html	Habilita el comando write_html sin ningún alcance preconfigurado.
clipboard-manager:deny-write-html	Deniega el comando write_html sin ningún alcance preconfigurado.
clipboard-manager:allow-write-image	Habilita el comando write_image sin ningún alcance preconfigurado.
clipboard-manager:deny-write-image	Deniega el comando write_image sin ningún alcance preconfigurado.
clipboard-manager:allow-write-text	Habilita el comando write_text sin ningún alcance preconfigurado.
clipboard-manager:deny-write-text	Deniega el comando write_text sin ningún alcance preconfigurado.