Start @xterm scope with core and webgl addons

This commit is contained in:
Daniel Imms
2023-11-01 06:44:26 -07:00
parent 4245283e05
commit add7f8133e
32 changed files with 34 additions and 34 deletions
@@ -1,25 +1,25 @@
## xterm-addon-webgl
## @xterm/addon-webgl
An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a WebGL2-based renderer. This addon requires xterm.js v4+.
### Install
```bash
npm install --save xterm-addon-webgl
npm install --save @xterm/addon-webgl
```
### Usage
```ts
import { Terminal } from 'xterm';
import { WebglAddon } from 'xterm-addon-webgl';
import { Terminal } from '@xterm/xterm';
import { WebglAddon } from '@xterm/addon-webgl';
const terminal = new Terminal();
terminal.open(element);
terminal.loadAddon(new WebglAddon());
```
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-webgl/typings/xterm-addon-webgl.d.ts) for more advanced usage.
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-webgl/typings/addon-webgl.d.ts) for more advanced usage.
### Handling Context Loss
@@ -1,13 +1,13 @@
{
"name": "xterm-addon-webgl",
"name": "@xterm/addon-webgl",
"version": "0.16.0",
"author": {
"name": "The xterm.js authors",
"url": "https://xtermjs.org/"
},
"main": "lib/xterm-addon-webgl.js",
"types": "typings/xterm-addon-webgl.d.ts",
"repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/xterm-addon-webgl",
"main": "lib/addon-webgl.js",
"types": "typings/addon-webgl.d.ts",
"repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-webgl",
"license": "MIT",
"keywords": [
"terminal",
@@ -5,7 +5,7 @@
import { Terminal, ITerminalAddon, IEvent } from 'xterm';
declare module 'xterm-addon-webgl' {
declare module '@xterm/addon-webgl' {
/**
* An xterm.js addon that provides search functionality.
*/
@@ -6,7 +6,7 @@
const path = require('path');
const addonName = 'WebglAddon';
const mainFile = 'xterm-addon-webgl.js';
const mainFile = 'addon-webgl.js';
module.exports = {
entry: `./out/${addonName}.js`,