Directory

← Back

XTerm Console Addon

Vaadin 14+ Java integration of xterm.js terminal emulator.

Author

Contributors

Rating

Features

  • Send input text to server
  • Programmatically write to the console
  • Clipboard support
  • Command line edition (cursor keys, insert, etc.)
  • ANSI escape sequences
  • And much more...

Sample code

XTerm xterm = new XTerm();
xterm.writeln("Hello world.\n\n");
xterm.setCursorBlink(true);
xterm.setCursorStyle(CursorStyle.UNDERLINE);
    	
xterm.setSizeFull();
xterm.loadFeature(new XTermClipboard(), clipboard->{
    clipboard.setCopySelection(true);
    clipboard.setUseSystemClipboard(UseSystemClipboard.READWRITE);
    clipboard.setPasteWithRightClick(true);
});

xterm.loadFeature(new XTermConsole(), console->{
    console.addLineListener(ev->{
    String line = ev.getLine();
    System.out.println(line);
});	
		
xterm.focus();
    	
xterm.getFeature(XTermFit.class).ifPresent(fit->{
   fit.fit();
});

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

New features:

  • Upgrade to XTerm version 5.1.0
  • Add method for enqueuing a listener before others
Released
2023-05-17
Maturity
BETA
License
Apache License 2.0

Compatibility

Framework
Vaadin 22
Vaadin 23
Vaadin 24
Vaadin 21 in 2.0.1
Vaadin 14 in 1.0.2
Browser
Firefox
Safari
Google Chrome
iOS Browser
Android Browser
Microsoft Edge
Online