xterm-addon-fit
Advanced tools
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+.
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.
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());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.
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.
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.
An addon for xterm.js that enables fitting the terminal's dimensions to a containing element. This addon requires xterm.js v4+.
npm install --save xterm-addon-fit
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.
FAQs
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+.
The npm package xterm-addon-fit receives a total of 111,850 weekly downloads. As such, xterm-addon-fit popularity was classified as popular.
We found that xterm-addon-fit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.