Class ClipboardAddon

Adds user-initiated MIME clipboard paste and Kitty clipboard protocol support.

Implements

TerminalAddon

Index

Constructors

Properties

Methods

activate dispose pasteFromClipboard

Constructors

constructor

new ClipboardAddon(options?: ClipboardAddonOptions): ClipboardAddon
Parameters
- options: ClipboardAddonOptions = {}
Returns ClipboardAddon
- Defined in packages/clipboard/src/index.ts:83

Properties

`Readonly`ready

ready: Promise<void>

Settles when Ghostty clipboard callbacks have been installed.

Methods

activate

activate(terminal: BrowserTerminal): void
Attaches native paste handling and enables Ghostty's clipboard protocol.
Parameters
- terminal: BrowserTerminal
Returns void
Implementation of TerminalAddon.activate
- Defined in packages/clipboard/src/index.ts:105

dispose

dispose(): void
Releases DOM listeners, snapshots, and Ghostty clipboard callbacks.

Returns void
Implementation of TerminalAddon.dispose
- Defined in packages/clipboard/src/index.ts:143

pasteFromClipboard

pasteFromClipboard(): Promise<ClipboardPasteResult>
Reads the system clipboard and pastes it into the terminal.

Returns Promise<ClipboardPasteResult>

Remarks
Call directly from a trusted click or keyboard handler. Browsers commonly reject clipboard reads after the user-activation task has ended.
- Defined in packages/clipboard/src/index.ts:133