waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update addon-clipboard readme

Browse Source
This commit is contained in:
Ayman Bagabas
2024-04-08 04:51:55 +03:00
parent fad97bc4d5
commit a709187007
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addons/addon-clipboard/README.md
+6 -5
View File
@@ -1,6 +1,7 @@
## @xterm/addon-clipboard
An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables accessing the system clipboard. This addon requires xterm.js v4+.
An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables
accessing the system clipboard. This addon requires xterm.js v4+.
### Install
@@ -22,8 +23,8 @@ terminal.loadAddon(clipboardAddon);
To use a custom clipboard provider
```ts
import { Terminal, IClipboardProvider, ClipboardSelection } from 'xterm';
import { ClipboardAddon } from '@xterm/addon-clipboard';
import { Terminal } from '@xterm/xterm';
import { ClipboardAddon, IClipboardProvider, ClipboardSelectionType } from '@xterm/addon-clipboard';
function b64Encode(data: string): string {
// Base64 encode impl
@@ -35,10 +36,10 @@ function b64Decode(data: string): string {
class MyCustomClipboardProvider implements IClipboardProvider {
private _data: string
public readText(selection: ClipboardSelection): Promise<string> {
public readText(selection: ClipboardSelectionType): Promise<string> {
return Promise.resolve(b64Encode(this._data));
}
public writeText(selection: ClipboardSelection, data: string): Promise<void> {
public writeText(selection: ClipboardSelectionType, data: string): Promise<void> {
this._data = b64Decode(data);
return Promise.resolve();
}