This library contains a variety of useful functions for console application
development, including:
Reading the current window dimensions (height, width)
Reading and setting the cursor location
Setting foreground and background colors
Manipulating the console into "raw mode", which allows more advanced
keyboard input processing than the default dart:io library.
Reading keys and control sequences from the keyboard
Writing aligned text to the screen
Tabular data display, including month calendar
The library has been used to implement a Dart version of the
Kilo text editor; when compiled with Dart it results in a self-contained
kilo executable. The library is sufficient for a reasonably complete set of
usage, including readline-style CLI and basic text games.
The library assumes a terminal that recognizes and implements common ANSI escape
sequences. The package has been tested on macOS, Linux and Windows 10. Note that
Windows did not support ANSI escape sequences in earlier
versions.
The library uses the win32 package for
accessing the Win32 API through FFI. That package contains many examples of
using Dart FFI for more complex examples.
Usage
A simple example for the dart_console package:
import'package:dart_console/dart_console.dart';
main() {
final console = Console();
console.clearScreen();
console.resetCursorPosition();
console.writeLine(
'Console size is ${console.windowWidth} cols and ${console.windowHeight} rows.',
TextAlignment.center,
);
console.writeLine();
return0;
}
More comprehensive demos of the Console class are provided, as follows:
Example
Description
demo.dart
Suite of test demos that showcase various capabilities
main.dart
Basic demo of how to get started with the dart_console
keys.dart
Demonstrates how dart_console processes control characters
