xterm-addon-clipboard to scoped module

This commit is contained in:
Daniel Imms
2023-11-03 11:45:21 -07:00
parent a4e6713823
commit aed94e5317
22 changed files with 23 additions and 23 deletions
+2 -2
View File
@@ -18,8 +18,8 @@
"addons/addon-attach/test/tsconfig.json",
"addons/addon-canvas/src/tsconfig.json",
"addons/addon-canvas/test/tsconfig.json",
"addons/xterm-addon-clipboard/src/tsconfig.json",
"addons/xterm-addon-clipboard/test/tsconfig.json",
"addons/addon-clipboard/src/tsconfig.json",
"addons/addon-clipboard/test/tsconfig.json",
"addons/addon-fit/src/tsconfig.json",
"addons/addon-fit/test/tsconfig.json",
"addons/addon-image/src/tsconfig.json",
+1 -1
View File
@@ -78,7 +78,7 @@ The xterm.js team maintains the following addons, but anyone can build them:
- [`@xterm/addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach): Attaches to a server running a process via a websocket
- [`@xterm/addon-canvas`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-canvas): Renders xterm.js using a `canvas` element's 2d context
- [`xterm-addon-clipboard`](https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-clipboard): Access the browser's clipboard
- [`@xterm/addon-clipboard`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard): Access the browser's clipboard
- [`@xterm/addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-fit): Fits the terminal to the containing element
- [`@xterm/addon-image`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-image): Adds image support
- [`@xterm/addon-search`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-search): Adds search functionality
@@ -1,18 +1,18 @@
## xterm-addon-clipboard
## @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+.
### Install
```bash
npm install --save xterm-addon-clipboard
npm install --save @xterm/addon-clipboard
```
### Usage
```ts
import { Terminal } from 'xterm';
import { ClipboardAddon } from 'xterm-addon-clipboard';
import { ClipboardAddon } from '@xterm/addon-clipboard';
const terminal = new Terminal();
const clipboardAddon = new ClipboardAddon();
@@ -23,7 +23,7 @@ To use a custom clipboard provider
```ts
import { Terminal, IClipboardProvider, ClipboardSelection } from 'xterm';
import { ClipboardAddon } from 'xterm-addon-clipboard';
import { ClipboardAddon } from '@xterm/addon-clipboard';
function b64Encode(data: string): string {
// Base64 encode impl
@@ -49,4 +49,4 @@ const clipboardAddon = new ClipboardAddon(new MyCustomClipboardProvider());
terminal.loadAddon(clipboardAddon);
```
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-clipboard/typings/xterm-addon-clipboard.d.ts) for more advanced usage.
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-clipboard/typings/addon-clipboard.d.ts) for more advanced usage.
@@ -1,13 +1,13 @@
{
"name": "xterm-addon-clipboard",
"name": "@xterm/addon-clipboard",
"version": "0.1.0",
"author": {
"name": "The xterm.js authors",
"url": "https://xtermjs.org/"
},
"main": "lib/xterm-addon-clipboard.js",
"types": "typings/xterm-addon-clipboard.d.ts",
"repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-clipboard",
"main": "lib/addon-clipboard.js",
"types": "typings/addon-clipboard.d.ts",
"repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard",
"license": "MIT",
"keywords": [
"terminal",
@@ -4,7 +4,7 @@
*/
import { ClipboardProvider } from './ClipboardProvider';
import { IClipboardProvider, IDisposable, ITerminalAddon, Terminal } from 'xterm';
import { IClipboardProvider, IDisposable, ITerminalAddon, Terminal } from '@xterm/xterm';
export class ClipboardAddon implements ITerminalAddon {
private _disposable: IDisposable | undefined;
@@ -4,7 +4,7 @@
*/
import { Base64 } from 'js-base64';
import { ClipboardSelectionType, IClipboardProvider } from 'xterm';
import { ClipboardSelectionType, IClipboardProvider } from '@xterm/xterm';
export class ClipboardProvider implements IClipboardProvider {
constructor(
@@ -5,7 +5,7 @@
import { Terminal, ITerminalAddon, IClipboardProvider, ClipboardSelection as ClipboardSelectionType } from 'xterm';
declare module 'xterm-addon-clipboard' {
declare module '@xterm/addon-clipboard' {
export class ClipboardProvider implements IClipboardProvider{
public readText(selection: ClipboardSelectionType): Promise<string>;
public writeText(selection: ClipboardSelectionType, data: string): Promise<void>;
@@ -6,7 +6,7 @@
const path = require('path');
const addonName = 'ClipboardAddon';
const mainFile = 'xterm-addon-clipboard.js';
const mainFile = 'addon-clipboard.js';
module.exports = {
entry: `./out/${addonName}.js`,
+1 -1
View File
@@ -29,7 +29,7 @@ if (changedFiles.some(e => e.search(/^addons\//) === -1)) {
const addonPackageDirs = [
path.resolve(__dirname, '../addons/addon-attach'),
path.resolve(__dirname, '../addons/addon-canvas'),
path.resolve(__dirname, '../addons/xterm-addon-clipboard'),
path.resolve(__dirname, '../addons/addon-clipboard'),
path.resolve(__dirname, '../addons/addon-fit'),
path.resolve(__dirname, '../addons/addon-image'),
path.resolve(__dirname, '../addons/addon-ligatures'),
+2 -2
View File
@@ -12,7 +12,7 @@
import { Terminal } from '../out/browser/public/Terminal';
import { AttachAddon } from '../addons/addon-attach/out/AttachAddon';
import { CanvasAddon } from '../addons/addon-canvas/out/CanvasAddon';
import { ClipboardAddon } from '../addons/xterm-addon-clipboard/out/ClipboardAddon';
import { ClipboardAddon } from '../addons/addon-clipboard/out/ClipboardAddon';
import { FitAddon } from '../addons/addon-fit/out/FitAddon';
import { SearchAddon, ISearchOptions } from '../addons/addon-search/out/SearchAddon';
import { SerializeAddon } from '../addons/addon-serialize/out/SerializeAddon';
@@ -33,7 +33,7 @@ if ('WebAssembly' in window) {
// Use webpacked version (yarn package)
// import { Terminal } from '../lib/xterm';
// import { AttachAddon } from '@xterm/addon-attach';
// import { ClipboardAddon } from 'xterm-addon-clipboard';
// import { ClipboardAddon } from '@xterm/addon-clipboard';
// import { FitAddon } from '@xterm/addon-fit';
// import { ImageAddon } from '@xterm/addon-image';
// import { SearchAddon, ISearchOptions } from '@xterm/addon-search';
+1 -1
View File
@@ -7,7 +7,7 @@
"baseUrl": ".",
"paths": {
"addon-attach": ["../addons/addon-attach"],
"xterm-addon-clipboard": ["../addons/xterm-addon-clipboard"],
"xterm-addon-clipboard": ["../addons/addon-clipboard"],
"addon-fit": ["../addons/addon-fit"],
"addon-image": ["../addons/addon-image"],
"addon-search": ["../addons/addon-search"],
+1 -1
View File
@@ -17,7 +17,7 @@ import { DEFAULT_OPTIONS } from 'common/services/OptionsService';
import { clone } from 'common/Clone';
import { BufferService } from 'common/services/BufferService';
import { CoreService } from 'common/services/CoreService';
import { ClipboardSelectionType } from 'xterm';
import { ClipboardSelectionType } from '@xterm/xterm';
function getCursor(bufferService: IBufferService): number[] {
return [

Some files were not shown because too many files have changed in this diff Show More