Skip to content

@jsvision/ui / ClipboardTextWriter

Type Alias: ClipboardTextWriter

ClipboardTextWriter = (text) => void | Promise<void>

Defined in: ui/src/event/types.ts:50

Write exact plain text to a host clipboard.

The callback may complete synchronously or return a promise. The event loop isolates either form of failure after committing its canonical clipboard value.

Parameters

text

string

The raw text copied or cut by the application.

Returns

void | Promise<void>

Example

ts
import type { ClipboardTextWriter } from '@jsvision/ui';

declare const hostClipboard: { writeText(text: string): Promise<void> };
const writeClipboardText: ClipboardTextWriter = (text) => hostClipboard.writeText(text);