Skip to content
Tauri
Releases

@tauri-apps/plugin-clipboard-manager

Read and write to the system clipboard.

Functions

readText()

function readText(): Promise<string>

Gets the clipboard content as plain text.

Returns

Promise<string>

Example

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

Since

2.0.0

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


writeText()

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

Writes plain text to the clipboard.

Parameters

ParameterType
textstring
opts?object
opts.label?string

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Example

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

Since

2.0.0

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


© 2024 Tauri Contributors. CC-BY / MIT