xterm-addon-fit

What is xterm-addon-fit?

The xterm-addon-fit npm package is an addon for the xterm.js terminal emulator that allows the terminal to automatically resize to fit its container. This is particularly useful for creating responsive terminal interfaces in web applications.

What are xterm-addon-fit's main functionalities?

Automatic Terminal Resizing

This feature allows the terminal to automatically resize to fit its container. The code sample demonstrates how to initialize the xterm.js terminal, load the fit addon, and fit the terminal to its container. It also shows how to make the terminal responsive to window resize events.

const { Terminal } = require('xterm');
const { FitAddon } = require('xterm-addon-fit');

const terminal = new Terminal();
const fitAddon = new FitAddon();
terminal.loadAddon(fitAddon);

// Attach the terminal to a DOM element
terminal.open(document.getElementById('terminal-container'));

// Fit the terminal to the container
fitAddon.fit();

// Optionally, you can fit the terminal whenever the window is resized
window.addEventListener('resize', () => fitAddon.fit());

Other packages similar to xterm-addon-fit

xterm-addon-web-links

The xterm-addon-web-links package is another addon for xterm.js that automatically turns URLs in the terminal into clickable links. While it does not provide resizing functionality, it enhances the terminal's interactivity by making URLs clickable.

xterm-addon-search

The xterm-addon-search package adds search functionality to the xterm.js terminal, allowing users to search for text within the terminal. This addon focuses on enhancing the usability of the terminal by providing search capabilities, unlike xterm-addon-fit which focuses on resizing.

xterm-addon-attach

The xterm-addon-attach package allows the xterm.js terminal to attach to a WebSocket stream, enabling real-time communication with a backend server. This addon is useful for creating live terminal sessions, whereas xterm-addon-fit is focused on resizing the terminal.

README

xterm-addon-fit

An addon for xterm.js that enables fitting the terminal's dimensions to a containing element. This addon requires xterm.js v4+.

Install

npm install --save xterm-addon-fit

Usage

import { Terminal } from 'xterm';
import { FitAddon } from 'xterm-addon-fit';

const terminal = new Terminal();
const fitAddon = new FitAddon();
terminal.loadAddon(fitAddon);
terminal.open(containerElement);
fitAddon.fit();

See the full API for more advanced usage.