ansi-escape-sequences

A simple library containing all known terminal ansi escape codes and sequences. Useful for adding colour to your command-line output, or building a dynamic text user interface.

API Reference

Example

const ansi = require('ansi-escape-sequences')

• ansi-escape-sequences
  • .cursor
    • .hide
    • .show
    • .up([lines]) ⇒ string
    • .down([lines]) ⇒ string
    • .forward([lines]) ⇒ string
    • .back([lines]) ⇒ string
    • .nextLine([lines]) ⇒ string
    • .previousLine([lines]) ⇒ string
    • .horizontalAbsolute(n) ⇒ string
    • .position(n, m) ⇒ string
  • .erase
    • .display(n) ⇒ string
    • .inLine(n) ⇒ string
  • .style : enum
  • .rgb(r, g, b) ⇒ string
  • .styles(effectArray) ⇒ string
  • .format(str, [styleArray]) ⇒ string

ansi.cursor

cursor-related sequences

Kind: static property of ansi-escape-sequences

• .cursor
  • .hide
  • .show
  • .up([lines]) ⇒ string
  • .down([lines]) ⇒ string
  • .forward([lines]) ⇒ string
  • .back([lines]) ⇒ string
  • .nextLine([lines]) ⇒ string
  • .previousLine([lines]) ⇒ string
  • .horizontalAbsolute(n) ⇒ string
  • .position(n, m) ⇒ string

cursor.hide

Hides the cursor

Kind: static property of cursor

cursor.show

Shows the cursor

Kind: static property of cursor

cursor.up([lines]) ⇒ string

Moves the cursor lines cells up. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.down([lines]) ⇒ string

Moves the cursor lines cells down. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.forward([lines]) ⇒ string

Moves the cursor lines cells forward. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.back([lines]) ⇒ string

Moves the cursor lines cells back. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.nextLine([lines]) ⇒ string

Moves cursor to beginning of the line n lines down.

Kind: static method of cursor

cursor.previousLine([lines]) ⇒ string

Moves cursor to beginning of the line n lines up.

Kind: static method of cursor

cursor.horizontalAbsolute(n) ⇒ string

Moves the cursor to column n.

Kind: static method of cursor

cursor.position(n, m) ⇒ string

Moves the cursor to row n, column m. The values are 1-based, and default to 1 (top left corner) if omitted.

Kind: static method of cursor

ansi.erase

erase sequences

Kind: static property of ansi-escape-sequences

• .erase
  • .display(n) ⇒ string
  • .inLine(n) ⇒ string

erase.display(n) ⇒ string

Clears part of the screen. If n is 0 (or missing), clear from cursor to end of screen. If n is 1, clear from cursor to beginning of the screen. If n is 2, clear entire screen.

Kind: static method of erase

erase.inLine(n) ⇒ string

Erases part of the line. If n is zero (or missing), clear from cursor to the end of the line. If n is one, clear from cursor to beginning of the line. If n is two, clear entire line. Cursor position does not change.

Kind: static method of erase

ansi.style : enum

Various formatting styles (aka Select Graphic Rendition codes).

Kind: static enum of ansi-escape-sequences
Properties

Example

console.log(ansi.style.red + 'this is red' + ansi.style.reset)

ansi.rgb(r, g, b) ⇒ string

Returns a 24-bit "true colour" escape sequence.

Kind: static method of ansi-escape-sequences

Example

> ansi.rgb(120, 0, 120)
'\u001b[38;2;120;0;120m'

ansi.styles(effectArray) ⇒ string

Returns an ansi sequence setting one or more effects

Kind: static method of ansi-escape-sequences

Example

> ansi.styles('green')
'\u001b[32m'

> ansi.styles([ 'green', 'underline' ])
'\u001b[32m\u001b[4m'

ansi.format(str, [styleArray]) ⇒ string

A convenience function, applying the provided styles to the input string and then resetting.

Inline styling can be applied using the syntax [style-list]{text to format}, where style-list is a space-separated list of styles from ansi.style. For example [bold white bg-red]{bold white text on a red background}. 24-bit "true colour" values can be set using rbg(n,n,n) syntax (no spaces), for example [rgb(255,128,0) underline]{orange underlined}.

Kind: static method of ansi-escape-sequences

Example

> ansi.format('what?', 'green')
'\u001b[32mwhat?\u001b[0m'

> ansi.format('what?', ['green', 'bold'])
'\u001b[32m\u001b[1mwhat?\u001b[0m'

> ansi.format('something', ['rgb(255,128,0)', 'bold'])
'\u001b[38;2;255;128;0m\u001b[1msomething\u001b[0m'

> ansi.format('[rgb(255,128,0) bold]{something}')
'\u001b[38;2;255;128;0m\u001b[1msomething\u001b[0m'

Load anywhere

This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation.

Node.js:

const ansi = require('ansi-escape-sequences')

Within Node.js with ECMAScript Module support enabled:

import ansi from 'ansi-escape-sequences'

Within a modern browser ECMAScript Module:

import ansi from './node_modules/ansi-escape-sequences/dist/index.mjs'

Old browser (adds window.ansi):

<script nomodule src="./node_modules/ansi-escape-sequences/dist/index.js"></script>

© 2014-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.