Files

25 lines
638 B
Markdown
Raw Permalink Normal View History

2023-11-01 10:35:10 -07:00
## @xterm/addon-fit
2019-09-09 09:28:33 -07:00
An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables fitting the terminal's dimensions to a containing element. This addon requires xterm.js v4+.
### Install
```bash
2023-11-01 10:35:10 -07:00
npm install --save @xterm/addon-fit
2019-09-09 09:28:33 -07:00
```
### Usage
```ts
2023-11-01 06:50:08 -07:00
import { Terminal } from '@xterm/xterm';
2023-11-01 10:35:10 -07:00
import { FitAddon } from '@xterm/addon-fit';
2019-09-09 09:28:33 -07:00
const terminal = new Terminal();
const fitAddon = new FitAddon();
terminal.loadAddon(fitAddon);
terminal.open(containerElement);
fitAddon.fit();
```
2023-11-01 10:35:10 -07:00
See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-fit/typings/addon-fit.d.ts) for more advanced usage.