Daniel ImmsandCursor
ebe7af5bf4
- addon-clipboard: "Note that this" instead of duplicate "this" - addon-webgl: remove stray "the" before "a" in event JSDoc - SharedRendererTests: duplicate "the" in test title - Types: "protocol" spelling in CoreMouseEncoding JSDoc - InputHandler: "a replacement char" article fix Co-authored-by: Cursor <cursoragent@cursor.com>
@xterm/addon-clipboard
An addon for xterm.js that enables accessing the system clipboard. This addon requires xterm.js v4+.
Install
npm install --save @xterm/addon-clipboard
Usage
import { Terminal } from 'xterm';
import { ClipboardAddon } from '@xterm/addon-clipboard';
const terminal = new Terminal();
const clipboardAddon = new ClipboardAddon();
terminal.loadAddon(clipboardAddon);
To use a custom clipboard provider
import { Terminal } from '@xterm/xterm';
import { ClipboardAddon, IClipboardProvider, ClipboardSelectionType } from '@xterm/addon-clipboard';
function b64Encode(data: string): string {
// Base64 encode impl
}
function b64Decode(data: string): string {
// Base64 decode impl
}
class MyCustomClipboardProvider implements IClipboardProvider {
private _data: string
public readText(selection: ClipboardSelectionType): Promise<string> {
return Promise.resolve(b64Encode(this._data));
}
public writeText(selection: ClipboardSelectionType, data: string): Promise<void> {
this._data = b64Decode(data);
return Promise.resolve();
}
}
const terminal = new Terminal();
const clipboardAddon = new ClipboardAddon(new MyCustomClipboardProvider());
terminal.loadAddon(clipboardAddon);
See the full API for more advanced usage.