ansi_escapes 2.0.0

SDKdartflutter
Platformandroidioswindowslinuxmacos

ANSI escape codes for manipulating the terminal.

ansi-escapes

ANSI escape codes for manipulating the terminal

Install

$ dart pub add ansi_escapes

Usage

import 'package:ansi_escapes/ansi_escapes.dart';

// Moves the cursor two rows up and to the left
stdout.write(ansiEscapes.cursorUp(2) + ansiEscapes.cursorLeft);
//=> '\u001B[2A\u001B[1000D'

API

FunctionDescription
cursorTo(x, y)Set the absolute position of the cursor. x0 y0 is the top left of the screen.
cursorMove(x, y)Set the position of the cursor relative to its current position.
cursorUp(count)Move cursor up a specific amount of rows. Default is 1.
cursorDown(count)Move cursor down a specific amount of rows. Default is 1.
cursorForward(count)Move cursor forward a specific amount of columns. Default is 1.
cursorBackward(count)Move cursor backward a specific amount of columns. Default is 1.
cursorLeftMove cursor to the left side.
cursorSavePositionSave cursor position.
cursorRestorePositionRestore saved cursor position.
cursorGetPositionGet cursor position.
cursorNextLineMove cursor to the next line.
cursorPrevLineMove cursor to the previous line.
cursorHideHide cursor.
cursorShowShow cursor.
eraseLines(count)Erase from the current cursor position up the specified amount of rows.
eraseEndLineErase from the current cursor position to the end of the current line.
eraseStartLineErase from the current cursor position to the start of the current line.
eraseLineErase the entire current line.
eraseDownErase the screen from the current line down to the bottom of the screen.
eraseUpErase the screen from the current line up to the top of the screen.
eraseScreenErase the screen and move the cursor the top left position.
scrollUpScroll display up one line.
scrollDownScroll display down one line.
clearScreenClear the terminal screen. (Viewport)
clearTerminalClear the whole terminal, including scrollback buffer. (Not just the visible part of it)
beepOutput a beeping sound.
link(text, url)Create a clickable link.

Supported terminals.

Inspired from Sindre Sorhus ansi-escapes package .