Xterm Svelte

xterm-svelte is a wrapper for the xterm.js library, designed to work seamlessly with SvelteKit. This library allows you to embed a fully functional terminal in your SvelteKit application.

Check it out: https://xterm-svelte.pages.dev

Version Compatibility

Version	Svelte Version	Branch	Demonstration
2.x.x	Svelte 5	main	https://xterm-svelte.pages.dev
1.x.x	Svelte 4	svelte4	https://svelte4.xterm-svelte.pages.dev

For details on migrating from version 1.x.x to 2.x.x, refer to the Migration Guide.

Features

• Full integration with SvelteKit

  Xterm-Svelte is designed to work seamlessly with SvelteKit, allowing you to easily incorporate terminal functionality into your SvelteKit projects.

• Xterm addons management

  Xterm addons are managed within Xterm-Svelte, providing a unified and consistent interface for working with Xterm and its addons.

• Continuous package updates

  Xterm-Svelte is regularly updated to ensure compatibility with the latest versions of SvelteKit and Xterm.js. This means you can always use the latest features and improvements from these libraries in your projects.

Installation

To install Xterm-Svelte, run the following command in your project directory:

npm install @battlefieldduck/xterm-svelte

Usage

Here's a basic example of how to use xterm-svelte in your SvelteKit application:

<script lang="ts">
	import { Xterm, XtermAddon } from '@battlefieldduck/xterm-svelte';
	import type {
		ITerminalOptions,
		ITerminalInitOnlyOptions,
		Terminal
	} from '@battlefieldduck/xterm-svelte';

	let terminal: Terminal;

	let options: ITerminalOptions & ITerminalInitOnlyOptions = {
		fontFamily: 'Consolas'
	};

	async function onLoad() {
		console.log('Child component has loaded');

		// FitAddon Usage
		const fitAddon = new (await XtermAddon.FitAddon()).FitAddon();
		terminal.loadAddon(fitAddon);
		fitAddon.fit();

		terminal.write('Hello World');
	}

	function onData(data: string) {
		console.log('onData()', data);
	}

	function onKey(data: { key: string; domEvent: KeyboardEvent }) {
		console.log('onKey()', data);
	}
</script>

<Xterm bind:terminal {options} {onLoad} {onData} {onKey} />

FAQ

When should I use onLoad()?

The onLoad() function fires when the xterm terminal is first initialized. You can use this function to perform actions such as initializing xterm addons.

Why is the terminal undefined?

One possible cause is that you called the terminal function before it was initialized. For example, if you run the terminal function in the onMount function without wrapping it with if (terminal !== undefined), it can lead to this issue.

Real-world uses

• Thymis: Thymis is an open-source project that aims to provide a seamless and secure IoT device management solution. With Thymis, users can easily configure and manage their devices running on the NixOS operating system.
• And much more...

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues.

License

xterm-svelte is licensed under the MIT License. See the LICENSE file for more details.

Stargazers over time