xterm2

Package version

xterm2 is a maintained fork of the original xterm package from TerminalStudio/xterm.dart. The original package is no longer maintained, so this fork continues the package under a new pub package name.

xterm2 is a fast and fully-featured terminal emulator for Flutter applications, with support for mobile and desktop platforms.

This package requires Flutter version >=3.27.0.

The terminal model also ships on its own as the pure-Dart xterm2_core package, for use without Flutter.

Screenshots

Features

  • 📦 Works out of the box No special configuration required.
  • 🚀 Fast Renders at 60fps.
  • 😀 Wide character support Supports CJK and emojis.
  • ✂️ Customizable
  • ✔ Frontend independent: The terminal core can work without flutter frontend.

What's new in 3.0.0:

  • 📱 Enhanced support for mobile platforms.
  • ⌨️ Integrates with Flutter's shortcut system.
  • 🎨 Allows changing theme at runtime.
  • 💪 Better performance. No tree rebuilds anymore.
  • 🈂️ Works with IMEs.

Getting Started

1. Add this to your package's pubspec.yaml file:

dependencies:
  ...
  xterm2: ^5.1.0

2. Create the terminal:

import 'package:xterm2/xterm.dart';
...
terminal = Terminal();

Listen to user interaction with the terminal by simply adding a onOutput callback:

terminal = Terminal();

terminal.onOutput = (output) {
  print('output: $output');
}

3. Create the view, attach the terminal to the view:

import 'package:xterm2/flutter.dart';
...
child: TerminalView(terminal),

4. Write something to the terminal:

terminal.write('Hello, world!');

Done!

Custom painting

Use TerminalView.paintExtension for application-owned graphics aligned with terminal cells. For example, draw a marker behind the first visible cell:

TerminalView(
  terminal,
  paintExtension: TerminalPaintExtension(
    beforeCellForegrounds: (frame) {
      frame.canvas.drawRect(
        frame.cellOffset(0, frame.firstRow) & frame.cellSize,
        Paint()..color = const Color(0x408080ff),
      );
    },
  ),
)

beforeCellBackgrounds, beforeCellForegrounds and afterCellForegrounds control paint order. Each callback has isolated canvas state and is clipped to frame.viewport; cellOffset uses buffer row coordinates and accounts for scrolling, padding and text scaling. The foreground callback runs before the selection/search overlays; the after callback can cover text and the focused block cursor. cellForegroundFilter optionally hides cell foregrounds, including selection/search recoloring, while keeping backgrounds and cursor geometry. Supply repaint with an application-owned Listenable to redraw without rebuilding the widget. Graphics decoding and protocol handling belong to the application. Omitting the extension preserves normal rendering.

More examples

For the original package history, see TerminalStudio/xterm.dart.

Features and bugs

Please file feature requests and bugs at the issue tracker.

Contributions are always welcome!

License

This project is licensed under an MIT license.