@tauri-apps/plugin-clipboard-manager

Lee y escribe en el portapapeles del sistema.

Funciones

clear()

function clear(): Promise<void>

Limpia el portapapeles.

Específico de la plataforma

• Android: Solo soportado en SDK 28+. Para versiones anteriores escribimos una cadena vacía en el portapapeles en su lugar.

Devuelve

Promise<void>

Ejemplo

import { clear } from '@tauri-apps/plugin-clipboard-manager';
await clear();

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L147

---

readImage()

function readImage(): Promise<Image>

Obtiene el contenido del portapapeles como una imagen Uint8Array.

Específico de la plataforma

• Android / iOS: No soportado.

Devuelve

Promise<Image>

Ejemplo

import { readImage } from '@tauri-apps/plugin-clipboard-manager';

const clipboardImage = await readImage();
const blob = new Blob([await clipboardImage.rgba()], { type: 'image' })
const url = URL.createObjectURL(blob)

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L99

---

readText()

function readText(): Promise<string>

Obtiene el contenido del portapapeles como texto plano.

Devuelve

Promise<string>

Ejemplo

import { readText } from '@tauri-apps/plugin-clipboard-manager';
const clipboardText = await readText();

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L46

---

writeHtml()

function writeHtml(html, altText?): Promise<void>

• Escribe HTML o recurre a escribir el texto plano proporcionado en el portapapeles.

Específico de la plataforma

• Android / iOS: No soportado.

Parámetros

Parámetro	Tipo
html	string
altText?	string

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

import { writeHtml } from '@tauri-apps/plugin-clipboard-manager';
await writeHtml('<h1>Tauri is awesome!</h1>', 'plaintext');
// The following will write "<h1>Tauri is awesome</h1>" as plain text
await writeHtml('<h1>Tauri is awesome!</h1>', '<h1>Tauri is awesome</h1>');
// we can read html data only as a string so there's just readText(), no readHtml()
assert(await readText(), '<h1>Tauri is awesome!</h1>');

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L126

---

writeImage()

function writeImage(image): Promise<void>

Escribe un búfer de imagen en el portapapeles.

Específico de la plataforma

• Android / iOS: No soportado.

Parámetros

Parámetro	Tipo
image	| string | number[] | ArrayBuffer | Uint8Array | Image

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
const buffer = [
  // A red pixel
  255, 0, 0, 255,

 // A green pixel
  0, 255, 0, 255,
];
await writeImage(buffer);

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L74

---

writeText()

function writeText(text, opts?): Promise<void>

Escribe texto plano en el portapapeles.

Parámetros

Parámetro	Tipo
text	string
opts?	object
opts.label?	string

Devuelve

Promise<void>

Una promesa que indica el éxito o el fallo de la operación.

Ejemplo

import { writeText, readText } from '@tauri-apps/plugin-clipboard-manager';
await writeText('Tauri is awesome!');
assert(await readText(), 'Tauri is awesome!');

Desde

2.0.0

Origen: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/clipboard-manager/guest-js/index.ts#L27