Function · Desktop Services

readClipboardText

Reads plain text from the desktop clipboard.

@sharpts/gui · SharpTS 572a2e31be0e

Signature

readClipboardText(): Promise<string>

Promise<string> — Clipboard text, or an empty string when no text is available.

Clipboard access is scheduled through the active desktop window and may require platform permission.

When no desktop window or system clipboard is available, or the platform rejects clipboard access.

import { readClipboardText } from "@sharpts/gui";

const text = await readClipboardText();
console.log(text);

src/SharpTS.Gui.Sdk/GuiPackage/runtime.ts:1639 at SharpTS revision 572a2e31be0e2a09be0138bc44501b34d6245b51.