Skip to main content

clipboard

@tauri-apps/api / clipboard

Module: clipboard

Read and write to the system clipboard.

This package is also accessible with window.__TAURI__.clipboard when tauri.conf.json > build > withGlobalTauri is set to true.

Functions

readText

readText(): Promise<string | null>

Gets the clipboard content as plain text.

example

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

Returns

Promise<string | null>

A promise resolving to the clipboard content as plain text.

Defined in

clipboard.ts:45


writeText

writeText(text): Promise<void>

Writes a plain text to the clipboard.

example

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

Parameters

NameType
textstring

Returns

Promise<void>

A promise indicating the success or failure of the operation.

Defined in

clipboard.ts:25