58 KiB

Raw Blame History

blessed

A curses-like library with a high level terminal interface API for node.js.

Blessed is over 16,000 lines of code and terminal goodness. It's completely implemented in javascript, and its goal consists of two things:

Reimplement ncurses entirely by parsing and compiling terminfo and termcap, and exposing a Program object which can output escape sequences compatible with any terminal.
Implement a widget API which is heavily optimized for terminals.

The blessed renderer makes use of CSR (change-scroll-region), and BCE (back-color-erase). It draws the screen using the painter's algorithm and is sped up with smart cursor movements and a screen damage buffer. This means rendering of your application will be extremely efficient: blessed only draws the changes (damage) to the screen.

Blessed is arguably as accurate as ncurses, but even more optimized in some ways. The widget library gives you an API which is reminiscent of the DOM. Anyone is able to make an awesome terminal application with blessed. There are terminal widget libraries for other platforms (primarily python and perl), but blessed is possibly the most DOM-like (dare I say the most user-friendly?).

Blessed has been used to implement other popular libraries and programs. Examples include: the slap text editor and blessed-contrib. The blessed API itself has gone on to inspire termui for Go.

Important Blessed Changes (>0.0.51)

The absolute .left property (not option) has been renamed to .aleft. The .rleft property has been renamed to .left. This should not have much effect on most applications. This includes all other coordinate properties.
autoPadding is now enabled by default. To revert to the original behavior, pass autoPadding: false into the screen object. That being said, it would be wiser to adjust your code to use autoPadding. non-autoPadding is now considered deprecated.

Install

$ npm install blessed

Example

This will render a box with line borders containing the text 'Hello world!', perfectly centered horizontally and vertically.

NOTE: It is recommend you use either smartCSR or fastCSR as a blessed.screen option. autoPadding is also recommended; it will automatically offset box content within borders instead of on top of them when coords are 0. non-autoPadding may be deprecated in the future. See the API documentation for further explanation of these options.

var blessed = require('blessed');

// Create a screen object.
var screen = blessed.screen({
  autoPadding: true,
  smartCSR: true
});

screen.title = 'my window title';

// Create a box perfectly centered horizontally and vertically.
var box = blessed.box({
  top: 'center',
  left: 'center',
  width: '50%',
  height: '50%',
  content: 'Hello {bold}world{/bold}!',
  tags: true,
  border: {
    type: 'line'
  },
  style: {
    fg: 'white',
    bg: 'magenta',
    border: {
      fg: '#f0f0f0'
    },
    hover: {
      bg: 'green'
    }
  }
});

// Append our box to the screen.
screen.append(box);

// Add a PNG icon to the box (X11 only)
var icon = blessed.image({
  parent: box,
  top: 0,
  left: 0,
  width: 'shrink',
  height: 'shrink',
  file: __dirname + '/my-program-icon.png',
  search: false
});

// If our box is clicked, change the content.
box.on('click', function(data) {
  box.setContent('{center}Some different {red-fg}content{/red-fg}.{/center}');
  screen.render();
});

// If box is focused, handle `enter`/`return` and give us some more content.
box.key('enter', function(ch, key) {
  box.setContent('{right}Even different {black-fg}content{/black-fg}.{/right}\n');
  box.setLine(1, 'bar');
  box.insertLine(1, 'foo');
  screen.render();
});

// Quit on Escape, q, or Control-C.
screen.key(['escape', 'q', 'C-c'], function(ch, key) {
  return process.exit(0);
});

// Focus our element.
box.focus();

// Render the screen.
screen.render();

API Documentation

Widgets

Blessed comes with a number of high-level widgets so you can avoid all the nasty low-level terminal stuff.

Node
Screen
Element
Box
Text
Line
ScrollableBox
ScrollableText
List
Form
Input
Textarea
Textbox
Button
ProgressBar
FileManager
Checkbox
RadioSet
RadioButton
Prompt
Question
Message
Loading
Listbar
Log
Table
ListTable
Terminal
Image
Layout

Node (from EventEmitter)

The base node which everything inherits from.

Options:

screen - the screen to be associated with.
parent - the desired parent.
children - an arrray of children.

Properties:

inherits all from EventEmitter.
type - type of the node (e.g. box).
options - original options object.
parent - parent node.
screen - parent screen.
children - array of node's children.
_data, , $ - an object for any miscellanous user data.
index - render index (document order index) of the last render call.

Events:

inherits all from EventEmitter.
adopt - received when node is added to a parent.
remove - received when node is removed from it's current parent.
reparent - received when node gains a new parent.
attach - received when node is attached to the screen directly or somewhere in its ancestry.
detach - received when node is detached from the screen directly or somewhere in its ancestry.

Methods:

inherits all from EventEmitter.
prepend(node) - prepend a node to this node's children.
append(node) - append a node to this node's children.
remove(node) - remove child node from node.
insert(node, i) - insert a node to this node's children at index i.
insertBefore(node, refNode) - insert a node to this node's children before the reference node.
insertAfter(node, refNode) - insert a node from node after the reference node.
detach() - remove node from its parent.
emitDescendants(type, args..., [iterator]) - emit event for element, and recursively emit same event for all descendants.
get(name, [default]) - get user property with a potential default value.
set(name, value) - set user property to value.

Screen (from Node)

The screen on which every other node renders.

Options:

program - the blessed Program to be associated with. will be automatically instantiated if none is provided.
smartCSR - attempt to perform CSR optimization on all possible elements (not just full-width ones, elements with uniform cells to their sides). this is known to cause flickering with elements that are not full-width, however, it is more optimal for terminal rendering.
fastCSR - do CSR on any element within 20 cols of the screen edge on either side. faster than smartCSR, but may cause flickering depending on what is on each side of the element.
useBCE - attempt to perform back_color_erase optimizations for terminals that support it. it will also work with terminals that don't support it, but only on lines with the default background color. as it stands with the current implementation, it's uncertain how much terminal performance this adds at the cost of overhead within node.
resizeTimeout - amount of time (in ms) to redraw the screen after the terminal is resized (default: 300).
tabSize - the width of tabs within an element's content.
autoPadding - automatically position child elements with border and padding in mind (NOTE: this is a recommended option. it may become default in the future).
artificialCursor - have blessed draw a custom cursor and hide the terminal cursor (experimental).
cursorShape - shape of the artificial cursor. can be: block, underline, or line.
cursorBlink - whether the artificial cursor blinks.
cursorColor - color of the artificial color. accepts any valid color value (null is default).
log - create a log file. see log method.
dump - dump all output and input to desired file. can be used together with log option if set as a boolean.
debug - debug mode. enables usage of the debug method. also creates a debug console which will display when pressing F12. it will display all log and debug messages.
ignoreLocked - Array of keys in their full format (e.g. C-c) to ignore when keys are locked. Useful for creating a key that will always exit no matter whether the keys are locked.
dockBorders - automatically "dock" borders with other elements instead of overlapping, depending on position (experimental). for example: These border-overlapped elements:

┌─────────┌─────────┐
│ box1    │ box2    │
└─────────└─────────┘

Become:

┌─────────┬─────────┐
│ box1    │ box2    │
└─────────┴─────────┘

ignoreDockContrast - normally, dockable borders will not dock if the colors or attributes are different. this option will allow them to dock regardless. it may produce some odd looking multi-colored borders though.
fullUnicode - allow for rendering of East Asian double-width characters, utf-16 surrogate pairs, and unicode combining characters. this allows you to display text above the basic multilingual plane. this is behind an option because it may affect performance slightly negatively. without this option enabled, all double-width, surrogate pair, and combining characters will be replaced by '??', '?', '' respectively. (NOTE: iTerm2 cannot display combining characters properly. blessed simply removes them from an element's content if iTerm2 is detected).

Properties:

inherits all from Node.
program - the blessed Program object.
tput - the blessed Tput object (only available if you passed tput: true to the Program constructor.)
focused - top of the focus history stack.
width - width of the screen (same as program.cols).
height - height of the screen (same as program.rows).
cols - same as screen.width.
rows - same as screen.height.
left - relative left offset, always zero.
right - relative right offset, always zero.
top - relative top offset, always zero.
bottom - relative bottom offset, always zero.
aleft - absolute left offset, always zero.
aright - absolute right offset, always zero.
atop - absolute top offset, always zero.
abottom - absolute bottom offset, always zero.
grabKeys - whether the focused element grabs all keypresses.
lockKeys - prevent keypresses from being received by any element.
hover - the currently hovered element. only set if mouse events are bound.
title - set or get window title.

Events:

inherits all from Node.
resize - received on screen resize.
mouse - received on mouse events.
keypress - received on key events.
element [name] - global events received for all elements.
key [name] - received on key event for [name].
focus, blur - received when the terminal window focuses/blurs. requires a terminal supporting the focus protocol and focus needs to be passed to program.enableMouse().
prerender - received before render.
render - received on render.

Methods:

inherits all from Node.
log(msg, ...) - write string to the log file if one was created.
debug(msg, ...) - same as the log method, but only gets called if the debug option was set.
alloc() - allocate a new pending screen buffer and a new output screen buffer.
draw(start, end) - draw the screen based on the contents of the screen buffer.
render() - render all child elements, writing all data to the screen buffer and drawing the screen.
clearRegion(x1, x2, y1, y2) - clear any region on the screen.
fillRegion(attr, ch, x1, x2, y1, y2) - fill any region with a character of a certain attribute.
focusOffset(offset) - focus element by offset of focusable elements.
focusPrevious() - focus previous element in the index.
focusNext() - focus next element in the index.
focusPush(element) - push element on the focus stack (equivalent to screen.focused = el).
focusPop() - pop element off the focus stack.
saveFocus() - save the focused element.
restoreFocus() - restore the saved focused element.
rewindFocus() - "rewind" focus to the last visible and attached element.
key(name, listener) - bind a keypress listener for a specific key.
onceKey(name, listener) - bind a keypress listener for a specific key once.
unkey(name, listener) - remove a keypress listener for a specific key.
spawn(file, args, options) - spawn a process in the foreground, return to blessed app after exit.
exec(file, args, options, callback) - spawn a process in the foreground, return to blessed app after exit. executes callback on error or exit.
readEditor([options], callback) - read data from text editor.
setEffects(el, fel, over, out, effects, temp) - set effects based on two events and attributes.
insertLine(n, y, top, bottom) - insert a line into the screen (using csr: this bypasses the output buffer).
deleteLine(n, y, top, bottom) - delete a line from the screen (using csr: this bypasses the output buffer).
insertBottom(top, bottom) - insert a line at the bottom of the screen.
insertTop(top, bottom) - insert a line at the top of the screen.
deleteBottom(top, bottom) - delete a line at the bottom of the screen.
deleteTop(top, bottom) - delete a line at the top of the screen.
enableMouse([el]) - enable mouse events for the screen and optionally an element (automatically called when a form of on('mouse') is bound).
enableKeys([el]) - enable keypress events for the screen and optionally an element (automatically called when a form of on('keypress') is bound).
enableInput([el]) - enable key and mouse events. calls bot enableMouse and enableKeys.
copyToClipboard(text) - attempt to copy text to clipboard using iTerm2's proprietary sequence. returns true if successful.
cursorShape(shape, blink) - attempt to change cursor shape. will not work in all terminals (see artificial cursors for a solution to this). returns true if successful.
cursorColor(color) - attempt to change cursor color. returns true if successful.
cursorReset() - attempt to reset cursor. returns true if successful.
screenshot([xi, xl, yi, yl]) - take an SGR screenshot of the screen within the region. returns a string containing only characters and SGR codes. can be displayed by simply echoing it in a terminal.

Element (from Node)

The base element.

Options:

fg, bg, bold, underline - attributes.
style - may contain attributes in the format of:

  {
    fg: 'blue',
    bg: 'black',
    border: {
      fg: 'blue'
    },
    scrollbar: {
      bg: 'blue'
    },
    focus: {
      bg: 'red'
    },
    hover: {
      bg: 'red'
    }
  }

border - border object, see below.
content - element's text content.
clickable - element is clickable.
input - element is focusable and can receive key input.
focused - element is focused.
hidden - whether the element is hidden.
label - a simple text label for the element.
hoverText - a floating text label for the element which appears on mouseover.
align - text alignment: left, center, or right.
valign - vertical text alignment: top, middle, or bottom.
shrink - shrink/flex/grow to content and child elements. width/height during render.
padding - amount of padding on the inside of the element. can be a number or an object containing the properties: left, right, top, and bottom.
width, height - width/height of the element, can be a number, percentage (0-100%), or keyword (half or shrink). percentages can also have offsets (50%+1, 50%-1).
left, right, top, bottom - offsets of the element relative to its parent. can be a number, percentage (0-100%), or keyword (center). right and bottom do not accept keywords. percentages can also have offsets (50%+1, 50%-1).
position - can contain the above options.
scrollable - whether the element is scrollable or not.
ch - background character (default is whitespace ).
draggable - allow the element to be dragged with the mouse.
shadow - draw a translucent offset shadow behind the element.

Properties:

inherits all from Node.
name - name of the element. useful for form submission.
border - border object.
- type - type of border (line or bg). bg by default.
- ch - character to use if bg type, default is space.
- bg, fg - border foreground and background, must be numbers (-1 for default).
- bold, underline - border attributes.
style - contains attributes (e.g. fg/bg/underline). see above.
position - raw width, height, and offsets.
content - raw text content.
hidden - whether the element is hidden or not.
visible - whether the element is visible or not.
detached - whether the element is attached to a screen in its ancestry somewhere.
fg, bg - foreground and background, must be numbers (-1 for default).
bold, underline - attributes.
width - calculated width.
height - calculated height.
left - calculated relative left offset.
right - calculated relative right offset.
top - calculated relative top offset.
bottom - calculated relative bottom offset.
aleft - calculated absolute left offset.
aright - calculated absolute right offset.
atop - calculated absolute top offset.
abottom - calculated absolute bottom offset.
draggable - whether the element is draggable. set to true to allow dragging.

Events:

inherits all from Node.
blur, focus - received when an element is focused or unfocused.
mouse - received on mouse events for this element.
- mousedown, mouseup - mouse button was pressed or released.
- wheeldown, wheelup - wheel was scrolled down or up.
- mouseover, mouseout - element was hovered or unhovered.
- mousemove - mouse was moved somewhere on this element.
- click - element was clicked (slightly smarter than mouseup).
keypress - received on key events for this element.
move - received when the element is moved.
resize - received when the element is resized.
key [name] - received on key event for [name].
prerender - received before a call to render.
render - received after a call to render.

Methods:

inherits all from Node.
note: if the scrollable option is enabled, Element inherits all methods from ScrollableBox.
render() - write content and children to the screen buffer.
hide() - hide element.
show() - show element.
toggle() - toggle hidden/shown.
focus() - focus element.
key(name, listener) - bind a keypress listener for a specific key.
onceKey(name, listener) - bind a keypress listener for a specific key once.
unkey(name, listener) - remove a keypress listener for a specific key.
onScreenEvent(type, handler) - same asel.on('screen', ...) except this will automatically keep track of which listeners are bound to the screen object. for use with removeScreenEvent(), free(), and destroy().
removeScreenEvent(type, handler) - same asel.removeListener('screen', ...) except this will automatically keep track of which listeners are bound to the screen object. for use with onScreenEvent(), free(), and destroy().
free() - free up the element. automatically unbind all events that may have been bound to the screen object. this prevents memory leaks. for use with onScreenEvent(), removeScreenEvent(), and destroy().
destroy() - same as the detach() method, except this will automatically call free() and unbind any screen events to prevent memory leaks. for use with onScreenEvent(), removeScreenEvent(), and free().
setIndex(z) - set the z-index of the element (changes rendering order).
setFront() - put the element in front of its siblings.
setBack() - put the element in back of its siblings.
setLabel(text/options) - set the label text for the top-left corner. example options: {text:'foo',side:'left'}
removeLabel() - remove the label completely.
setHover(text/options) - set a hover text box to follow the cursor. similar to the "title" DOM attribute in the browser. example options: {text:'foo'}
removeHover() - remove the hover label completely.
enableMouse() - enable mouse events for the element (automatically called when a form of on('mouse') is bound).
enableKeys() - enable keypress events for the element (automatically called when a form of on('keypress') is bound).
enableInput() - enable key and mouse events. calls bot enableMouse and enableKeys.
enableDrag() - enable dragging of the element.
disableDrag() - disable dragging of the element.
screenshot([xi, xl, yi, yl]) - take an SGR screenshot of the element within the region. returns a string containing only characters and SGR codes. can be displayed by simply echoing it in a terminal.

Content Methods

Methods for dealing with text content, line by line. Useful for writing a text editor, irc client, etc.

Note: all of these methods deal with pre-aligned, pre-wrapped text. If you use deleteTop() on a box with a wrapped line at the top, it may remove 3-4 "real" lines (rows) depending on how long the original line was.

The lines parameter can be a string or an array of strings. The line parameter must be a string.

setContent(text) - set the content. note: when text is input, it will be stripped of all non-SGR escape codes, tabs will be replaced with 8 spaces, and tags will be replaced with SGR codes (if enabled).
getContent() - return content, slightly different from el.content. assume the above formatting.
setText(text) - similar to setContent, but ignore tags and remove escape codes.
getText() - similar to getContent, but return content with tags and escape codes removed.
insertLine(i, lines) - insert a line into the box's content.
deleteLine(i) - delete a line from the box's content.
getLine(i) - get a line from the box's content.
getBaseLine(i) - get a line from the box's content from the visible top.
setLine(i, line) - set a line in the box's content.
setBaseLine(i, line) - set a line in the box's content from the visible top.
clearLine(i) - clear a line from the box's content.
clearBaseLine(i) - clear a line from the box's content from the visible top.
insertTop(lines) - insert a line at the top of the box.
insertBottom(lines) - insert a line at the bottom of the box.
deleteTop() - delete a line at the top of the box.
deleteBottom() - delete a line at the bottom of the box.
unshiftLine(lines) - unshift a line onto the top of the content.
shiftLine(i) - shift a line off the top of the content.
pushLine(lines) - push a line onto the bottom of the content.
popLine(i) - pop a line off the bottom of the content.
getLines() - an array containing the content lines.
getScreenLines() - an array containing the lines as they are displayed on the screen.
strWidth(text) - get a string's displayed width, taking into account double-width, surrogate pairs, combining characters, tags, and SGR escape codes.

Box (from Element)

A box element which draws a simple box containing content or other elements.

Options:

inherits all from Element.

Properties:

inherits all from Element.

Events:

inherits all from Element.

Methods:

inherits all from Element.

Text (from Element)

An element similar to Box, but geared towards rendering simple text elements.

Options:

inherits all from Element.
fill - fill the entire line with chosen bg until parent bg ends, even if there is not enough text to fill the entire width. (deprecated)
align - text alignment: left, center, or right.

Inherits all options, properties, events, and methods from Element.

Line (from Box)

A simple line which can be line or bg styled.

Options:

inherits all from Box.
orientation - can be vertical or horizontal.
type, bg, fg, ch - treated the same as a border object. (attributes can be contained in style).

Inherits all options, properties, events, and methods from Box.

ScrollableBox (from Box)

DEPRECATED - Use Box with the scrollable option instead.

A box with scrollable content.

Options:

inherits all from Box.
baseLimit - a limit to the childBase. default is Infinity.
alwaysScroll - a option which causes the ignoring of childOffset. this in turn causes the childBase to change every time the element is scrolled.
scrollbar - object enabling a scrollbar.
scrollbar.style - style of the scrollbar.
scrollbar.track - style of the scrollbar track if present (takes regular style options).

Properties:

inherits all from Box.
childBase - the offset of the top of the scroll content.
childOffset - the offset of the chosen item/line.

Events:

inherits all from Box.
scroll - received when the element is scrolled.

Methods:

scroll(offset) - scroll the content by a relative offset.
scrollTo(index) - scroll the content to an absolute index.
setScroll(index) - same as scrollTo.
setScrollPerc(perc) - set the current scroll index in percentage (0-100).
getScroll() - get the current scroll index in lines.
getScrollHeight() - get the actual height of the scrolling area.
getScrollPerc() - get the current scroll index in percentage.
resetScroll() - reset the scroll index to its initial state.

ScrollableText (from ScrollableBox)

DEPRECATED - Use Box with the scrollable and alwaysScroll options instead.

A scrollable text box which can display and scroll text, as well as handle pre-existing newlines and escape codes.

Options:

inherits all from ScrollableBox.
mouse - whether to enable automatic mouse support for this element.
keys - use predefined keys for navigating the text.
vi - use vi keys with the keys option.

Properties:

inherits all from ScrollableBox.

Events:

inherits all from ScrollableBox.

Methods:

inherits all from ScrollableBox.

List (from Box)

A scrollable list which can display selectable items.

Options:

inherits all from Box.
style.selected - style for a selected item.
style.item - style for an unselected item.
mouse - whether to automatically enable mouse support for this list (allows clicking items).
keys - use predefined keys for navigating the list.
vi - use vi keys with the keys option.
items - an array of strings which become the list's items.
search - a function that is called when vi mode is enabled and the key / is pressed. This function accepts a callback function which should be called with the search string. The search string is then used to jump to an item that is found in items.
interactive - whether the list is interactive and can have items selected (default: true).
invertSelected - whether to automatically override tags and invert fg of item when selected (default: true).

Properties:

inherits all from Box.

Events:

inherits all from Box.
select - received when an item is selected.
cancel - list was canceled (when esc is pressed with the keys option).
action - either a select or a cancel event was received.

Methods:

inherits all from Box.
add/addItem(text) - add an item based on a string.
removeItem(child) - removes an item from the list. child can be an element, index, or string.
pushItem(child) - push an item onto the list.
popItem() - pop an item off the list.
unshiftItem(child) - unshift an item onto the list.
shiftItem() - shift an item off the list.
insertItem(i, child) - inserts an item to the list. child can be an element, index, or string.
getItem(child) - returns the item element. child can be an element, index, or string.
setItem(child, content) - set item to content.
spliceItem(i, n, item1, ...) - remove and insert items to the list.
clearItems() - clears all items from the list.
setItems(items) - sets the list items to multiple strings.
getItemIndex(child) - returns the item index from the list. child can be an element, index, or string.
select(index) - select an index of an item.
move(offset) - select item based on current offset.
up(amount) - select item above selected.
down(amount) - select item below selected.
pick(callback) - show/focus list and pick an item. the callback is executed with the result.
fuzzyFind([string/regex/callback]) - find an item based on its text content.

Form (from Box)

A form which can contain form elements.

Options:

inherits all from Box.
keys - allow default keys (tab, vi keys, enter).
vi - allow vi keys.

Properties:

inherits all from Box.
submission - last submitted data.

Events:

inherits all from Box.
submit - form is submitted. receives a data object.
cancel - form is discarded.
reset - form is cleared.

Methods:

inherits all from Box.
focusNext() - focus next form element.
focusPrevious() - focus previous form element.
submit() - submit the form.
cancel() - discard the form.
reset() - clear the form.

Input (from Box)

A form input.

Textarea (from Input)

A box which allows multiline text input.

Options:

inherits all from Input.
keys - use pre-defined keys (i or enter for insert, e for editor, C-e for editor while inserting).
mouse - use pre-defined mouse events (right-click for editor).
inputOnFocus - call readInput() when the element is focused. automatically unfocus.

Properties:

inherits all from Input.
value - the input text. read-only.

Events:

inherits all from Input.
submit - value is submitted (enter).
cancel - value is discared (escape).
action - either submit or cancel.

Methods:

inherits all from Input.
submit - submit the textarea (emits submit).
cancel - cancel the textarea (emits cancel).
readInput(callback) - grab key events and start reading text from the keyboard. takes a callback which receives the final value.
readEditor(callback) - open text editor in $EDITOR, read the output from the resulting file. takes a callback which receives the final value.
getValue() - the same as this.value, for now.
clearValue() - clear input.
setValue(text) - set value.

Textbox (from Textarea)

A box which allows text input.

Options:

inherits all from Textarea.
secret - completely hide text.
censor - replace text with asterisks (*).

Properties:

inherits all from Textarea.
secret - completely hide text.
censor - replace text with asterisks (*).

Events:

inherits all from Textarea.

Methods:

inherits all from Textarea.

Button (from Input)

A button which can be focused and allows key and mouse input.

Options:

inherits all from Input.

Properties:

inherits all from Input.

Events:

inherits all from Input.
press - received when the button is clicked/pressed.

Methods:

inherits all from Input.
press() - press button. emits press.

ProgressBar (from Input)

A progress bar allowing various styles. This can also be used as a form input.

Options:

inherits all from Input.
orientation - can be horizontal or vertical.
style.bar - style of the bar contents itself.
pch - the character to fill the bar with (default is space).
filled - the amount filled (0 - 100).
value - same as filled.
keys - enable key support.
mouse - enable mouse support.

Properties:

inherits all from Input.

Events:

inherits all from Input.
reset - bar was reset.
complete - bar has completely filled.

Methods:

inherits all from Input.
progress(amount) - progress the bar by a fill amount.
setProgress(amount) - set progress to specific amount.
reset() - reset the bar.

FileManager (from List)

A very simple file manager for selecting files.

Options:

inherits all from List.
cwd - current working directory.

Properties:

inherits all from List.
cwd - current working directory.

Events:

inherits all from List.
cd - directory was selected and navigated to.
file - file was selected.

Methods:

inherits all from List.
refresh([cwd], [callback]) - refresh the file list (perform a readdir on cwd and update the list items).
pick([cwd], callback) - pick a single file and return the path in the callback.
reset([cwd], [callback]) - reset back to original cwd.

Checkbox (from Input)

A checkbox which can be used in a form element.

Options:

inherits all from Input.
checked - whether the element is checked or not.
mouse - enable mouse support.

Properties:

inherits all from Input.
text - the text next to the checkbox (do not use setContent, use check.text = '').
checked - whether the element is checked or not.
value - same as checked.

Events:

inherits all from Input.
check - received when element is checked.
uncheck received when element is unchecked.

Methods:

inherits all from Input.
check() - check the element.
uncheck() - uncheck the element.
toggle() - toggle checked state.

RadioSet (from Box)

An element wrapping RadioButtons. RadioButtons within this element will be mutually exclusive with each other.

Options:

inherits all from Box.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.

RadioButton (from Checkbox)

A radio button which can be used in a form element.

Options:

inherits all from Checkbox.

Properties:

inherits all from Checkbox.

Events:

inherits all from Checkbox.

Methods:

inherits all from Checkbox.

Prompt (from Box)

A prompt box containing a text input, okay, and cancel buttons (automatically hidden).

Options:

inherits all from Box.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
input/setInput/readInput(text, value, callback) - show the prompt and wait for the result of the textbox. set text and initial value.

Question (from Box)

A question box containing okay and cancel buttons (automatically hidden).

Options:

inherits all from Box.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
ask(question, callback) - ask a question. callback will yield the result.

Message (from Box)

A box containing a message to be displayed (automatically hidden).

Options:

inherits all from Box.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
log/display(text, [time], callback) - display a message for a time (default is 3 seconds). set time to 0 for a perpetual message that is dismissed on keypress.
error(text, [time], callback) - display an error in the same way.

Loading (from Box)

A box with a spinning line to denote loading (automatically hidden).

Options:

inherits all from Box.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
load(text) - display the loading box with a message. will lock keys until stop is called.
stop() - hide loading box. unlock keys.

Listbar (from Box)

A horizontal list. Useful for a main menu bar.

Options:

inherits all from Box.
style.selected - style for a selected item.
style.item - style for an unselected item.
commands/items - set buttons using an object with keys as titles of buttons, containing of objects containing keys of keys and callback.
autoCommandKeys - automatically bind list buttons to keys 0-9.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
setItems(commands) - set commands (see commands option above).
add/addItem/appendItem(item, callback) - append an item to the bar.
select(offset) - select an item on the bar.
removeItem(child) - remove item from the bar.
move(offset) - move relatively across the bar.
moveLeft(offset) - move left relatively across the bar.
moveRight(offset) - move right relatively across the bar.
selectTab(index) - select button and execute its callback.

Log (from ScrollableText)

A log permanently scrolled to the bottom.

Options:

inherits all from ScrollableText.
scrollback - amount of scrollback allowed. default: Infinity.
scrollOnInput - scroll to bottom on input even if the user has scrolled up. default: false.

Properties:

inherits all from ScrollableText.
scrollback - amount of scrollback allowed. default: Infinity.
scrollOnInput - scroll to bottom on input even if the user has scrolled up. default: false.

Events:

inherits all from ScrollableText.
log - emitted on a log line. passes in line.

Methods:

inherits all from ScrollableText.
log/add(text) - add a log line.

Table (from Box)

A stylized table of text elements.

Options:

inherits all from Box.
rows/data - array of array of strings representing rows.
pad - spaces to attempt to pad on the sides of each cell. 2 by default: one space on each side (only useful if the width is shrunken).
noCellBorders - do not draw inner cells.
fillCellBorders - fill cell borders with the adjacent background color.
style.header - header style.
style.cell - cell style.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
setRows/setData(rows) - set rows in table. array of arrays of strings.

  table.setData([
    [ 'Animals',  'Foods'  ],
    [ 'Elephant', 'Apple'  ],
    [ 'Bird',     'Orange' ]
  ]);

ListTable (from List)

A stylized table of text elements with a list.

Options:

inherits all from List.
rows/data - array of array of strings representing rows.
pad - spaces to attempt to pad on the sides of each cell. 2 by default: one space on each side (only useful if the width is shrunken).
noCellBorders - do not draw inner cells.
style.header - header style.
style.cell - cell style.

Properties:

inherits all from List.

Events:

inherits all from List.

Methods:

inherits all from List.
setRows/setData(rows) - set rows in table. array of arrays of strings.

  table.setData([
    [ 'Animals',  'Foods'  ],
    [ 'Elephant', 'Apple'  ],
    [ 'Bird',     'Orange' ]
  ]);

Terminal (from Box)

A box which spins up a pseudo terminal and renders the output. Useful for writing a terminal multiplexer, or something similar to an mc-like file manager. Requires term.js and pty.js to be installed. See example/multiplex.js for an example terminal multiplexer.

Options:

inherits all from Box.
handler - handler for input data.
shell - name of shell. $SHELL by default.
args - args for shell.
cursor - can be line, underline, and block.
Other options similar to term.js'.

Properties:

inherits all from Box.
term - reference to the headless term.js terminal.
pty - reference to the pty.js pseudo terminal.

Events:

inherits all from Box.
title - window title from terminal.
Other events similar to ScrollableBox.

Methods:

inherits all from Box.
write(data) - write data to the terminal.
screenshot([xi, xl, yi, xl]) - nearly identical to element.screenshot, however, the specified region includes the terminal's entire scrollback, rather than just what is visible on the screen.
Other methods similar to ScrollableBox.

Image (from Box)

Display an image in the terminal (jpeg, png, gif) using w3mimgdisplay. Requires w3m to be installed. X11 required: works in xterm, urxvt, and possibly other terminals.

Options:

inherits all from Box.
file - path to image.
w3m - path to w3mimgdisplay. if a proper w3mimgdisplay path is not given, blessed will search the entire disk for the binary.

Properties:

inherits all from Box.

Events:

inherits all from Box.

Methods:

inherits all from Box.
setImage(img, callback) - set the image in the box to a new path.
clearImage(callback) - clear the current image.
imageSize(img, callback) - get the size of an image file in pixels.
termSize(callback) - get the size of the terminal in pixels.
getPixelRatio(callback) - get the pixel to cell ratio for the terminal.

Layout (from Element)

A layout which can position children automatically based on a renderer method (experimental - the mechanics of this element may be changed in the future!).

By default, the Layout element automatically positions children as if they were display: inline-block; in CSS.

Options:

inherits all from Element.
renderer - a callback which is called right before the children are iterated over to be rendered. should return an iterator callback which is called on each child element: iterator(el, i).
layout - using the default renderer, it provides two layouts: inline, and grid. inline is the default and will render akin to inline-block. grid will create an automatic grid based on element dimensions. the grid cells' width and height are always determined by the largest children in the layout.

Properties:

inherits all from Element.

Events:

inherits all from Element.

Methods:

inherits all from Element.
renderer(coords) - a callback which is called right before the children are iterated over to be rendered. should return an iterator callback which is called on each child element: iterator(el, i).
isRendered(el) - check to see if a previous child element has been rendered and is visible on screen. this is only useful for checking child elements that have already been attempted to be rendered! see the example below.
getLast(i) - get the last rendered and visible child element based on an index. this is useful for basing the position of the current child element on the position of the last child element.
getLastCoords(i) - get the last rendered and visible child element coords based on an index. this is useful for basing the position of the current child element on the position of the last child element. see the example below.

Rendering a Layout for child elements

Notes

You must always give Layout a width and height. This is a chicken-and-egg problem: blessed cannot calculate the width and height dynamically before the children are positioned.

border and padding are already calculated into the coords object the renderer receives, so there is no need to account for it in your renderer.

Try to set position for children using el.position. el.position is the most primitive "to-be-rendered" way to set coordinates. Setting el.left directly has more dynamic behavior which may interfere with rendering.

Some definitions for coords (otherwise known as el.lpos):

coords.xi - the absolute x coordinate of the left side of a rendered element. it is absolute: relative to the screen itself.
coords.xl - the absolute x coordinate of the right side of a rendered element. it is absolute: relative to the screen itself.
coords.yi - the absolute y coordinate of the top side of a rendered element. it is absolute: relative to the screen itself.
coords.yl - the absolute y coordinate of the bottom side of a rendered element. it is absolute: relative to the screen itself.

Note again: the coords the renderer receives for the Layout already has border and padding subtracted, so you do not have to account for these. The children do not.

Example

Here is an example of how to provide a renderer. Note that this is also the default renderer if none is provided. This renderer will render each child as though they were display: inline-block; in CSS, as if there were a dynamically sized horizontal grid from left to right.

var layout = blessed.layout({
  parent: screen,
  top: 'center',
  left: 'center',
  width: '50%',
  height: '50%',
  border: 'line',
  style: {
    bg: 'red',
    border: {
      fg: 'blue'
    }
  },
  // NOTE: This is already the default renderer if none is provided!
  renderer: function(coords) {
    var self = this;

    // The coordinates of the layout element
    var width = coords.xl - coords.xi
      , height = coords.yl - coords.yi
      , xi = coords.xi
      , xl = coords.xl
      , yi = coords.yi
      , yl = coords.yl;

    // The current row offset in cells (which row are we on?)
    var rowOffset = 0;

    // The index of the first child in the row
    var rowIndex = 0;

    return function iterator(el, i) {
      // Make our children shrinkable. If they don't have a height, for
      // example, calculate it for them.
      el.shrink = true;

      // Find the previous rendered child's coordinates
      var last = self.getLastCoords(i);

      // If there is no previously rendered element, we are on the first child.
      if (!last) {
        el.position.left = 0;
        el.position.top = 0;
      } else {
        // Otherwise, figure out where to place this child. We'll start by
        // setting it's `left`/`x` coordinate to right after the previous
        // rendered element. This child will end up directly to the right of it.
        el.position.left = last.xl - xi;

        // If our child does not overlap the right side of the Layout, set it's
        // `top`/`y` to the current `rowOffset` (the coordinate for the current
        // row).
        if (el.position.left + el.width <= width) {
          el.position.top = rowOffset;
        } else {
          // Otherwise we need to start a new row and calculate a new
          // `rowOffset` and `rowIndex` (the index of the child on the current
          // row).
          rowOffset += self.children.slice(rowIndex, i).reduce(function(out, el) {
            if (!self.isRendered(el)) return out;
            out = Math.max(out, el.lpos.yl - el.lpos.yi);
            return out;
          }, 0);
          rowIndex = i;
          el.position.left = 0;
          el.position.top = rowOffset;
        }
      }

      // If our child overflows the Layout, do not render it!
      // Disable this feature for now.
      if (el.position.top + el.height > height) {
        // Returning false tells blessed to ignore this child.
        // return false;
      }
    };
  }
});

for (var i = 0; i < 10; i++) {
  blessed.box({
    parent: layout,
    width: i % 2 === 0 ? 10 : 20,
    height: i % 2 === 0 ? 5 : 10,
    border: 'line'
  });
}

Artificial Cursors

Terminal cursors can be tricky. They all have different custom escape codes to alter. As an experimental alternative, blessed can draw a cursor for you, allowing you to have a custom cursor that you control.

var screen = blessed.screen({
  cursor: {
    artificial: true,
    shape: 'line',
    blink: true,
    color: null // null for default
  }
});

That's it. It's controlled the same way as the regular cursor.

To create a custom cursor:

var screen = blessed.screen({
  cursor: {
    artificial: true,
    shape: {
      bg: 'red',
      fg: 'white',
      bold: true,
      ch: '#'
    },
    blink: true
  }
});

Positioning

Offsets may be a number, a percentage (e.g. 50%), or a keyword (e.g. center).

Dimensions may be a number, or a percentage (e.g. 50%).

Positions are treated almost exactly the same as they are in CSS/CSSOM when an element has the position: absolute CSS property.

When an element is created, it can be given coordinates in its constructor:

var box = blessed.box({
  left: 'center',
  top: 'center',
  bg: 'yellow',
  width: '50%',
  height: '50%'
});

This tells blessed to create a box, perfectly centered relative to its parent, 50% as wide and 50% as tall as its parent.

Percentages can also have offsets applied to them:

  ...
  height: '50%-1',
  left: '45%+1',
  ...

To access the calculated offsets, relative to the parent:

console.log(box.left);
console.log(box.top);

To access the calculated offsets, absolute (relative to the screen):

console.log(box.aleft);
console.log(box.atop);

Overlapping offsets and dimensions greater than parents'

This still needs to be tested a bit, but it should work.

Content

Every element can have text content via setContent. If tags: true was passed to the element's constructor, the content can contain tags. For example:

box.setContent('hello {red-fg}{green-bg}{bold}world{/bold}{/green-bg}{/red-fg}');

To make this more concise {/} cancels all character attributes.

box.setContent('hello {red-fg}{green-bg}{bold}world{/}');

Tags can also use hex colors (which will be reduced to the most accurate terminal color):

box.setContent('{#ff0000-fg}{bold}red and bold{/}');

Newlines and alignment are also possible in content.

box.setContent('hello\n'
  + '{right}world{/right}\n'
  + '{center}foo{/center}\n');
  + 'left{|}right');

This will produce a box that looks like:

| hello                 |
|                 world |
|          foo          |
| left            right |

Content can also handle SGR escape codes. This means if you got output from a program, say git log for example, you can feed it directly to an element's content and the colors will be parsed appropriately.

This means that while {red-fg}foo{/red-fg} produces ^[[31mfoo^[[39m, you could just feed ^[[31mfoo^[[39m directly to the content.

Event Bubbling

Events can bubble in blessed. For example:

Receiving all click events for box:

box.on('click', function(mouse) {
  box.setContent('You clicked ' + mouse.x + ', ' + mouse.y + '.');
  screen.render();
});

Receiving all click events for box, as well as all of its children:

box.on('element click', function(el, mouse) {
  box.setContent('You clicked '
    + el.type + ' at ' + mouse.x + ', ' + mouse.y + '.');
  screen.render();
  if (el === box) {
    return false; // Cancel propagation.
  }
});

el gets passed in as the first argument. It refers to the target element the event occurred on. Returning false will cancel propagation up the tree.

Rendering

To actually render the screen buffer, you must call render.

box.setContent('Hello {#0fe1ab-fg}world{/}.');
screen.render();

Elements are rendered with the lower elements in the children array being painted first. In terms of the painter's algorithm, the lowest indicies in the array are the furthest away, just like in the DOM.

Windows compatibility

Currently there is no mouse or resize event support on Windows.

Windows users will need to explicitly set term when creating a screen like so (NOTE: This is no longer necessary as of the latest versions of blessed. This is now handled automatically):

var screen = blessed.screen({ term: 'windows-ansi' });

Testing

Most tests contained in the test/ directory are interactive. It's up to the programmer to determine whether the test is properly displayed. In the future it might be better to do something similar to vttest.

Lower-Level Usage

This will actually parse the xterm terminfo and compile every string capability to a javascript function:

var blessed = require('blessed');

var tput = blessed.tput({
  terminal: 'xterm-256color',
  extended: true
});

process.stdout.write(tput.setaf(4) + 'Hello' + tput.sgr0() + '\n');

To play around with it on the command line, it works just like tput:

$ tput.js setaf 2
$ tput.js sgr0
$ echo "$(tput.js setaf 2)Hello World$(tput.js sgr0)"

The main functionality is exposed in the main blessed module:

var blessed = require('blessed')
  , program = blessed.program();

program.key('q', function(ch, key) {
  program.clear();
  program.disableMouse();
  program.showCursor();
  program.normalBuffer();
  process.exit(0);
});

program.on('mouse', function(data) {
  if (data.action === 'mousemove') {
    program.move(data.x, data.y);
    program.bg('red');
    program.write('x');
    program.bg('!red');
  }
});

program.alternateBuffer();
program.enableMouse();
program.hideCursor();
program.clear();

program.move(1, 1);
program.bg('black');
program.write('Hello world', 'blue fg');
program.setx((program.cols / 2 | 0) - 4);
program.down(5);
program.write('Hi again!');
program.bg('!black');
program.feed();

FAQ

Why doesn't the Linux console render lines correctly on Ubuntu?

You need to install the ncurses-base package and the ncurses-term package. (#98)

Why do vertical lines look chopped up in iTerm2?

All ACS vertical lines look this way in iTerm2 with the default font.

Why can't I use my mouse in Terminal.app?

Terminal.app does not support mouse events.

Why doesn't the Image element appear in my terminal?

The Image element uses w3m to display images. This generally only works on X11+xterm/urxvt, but it may work on other unix terminals.

Why can't my mouse clicks register beyond 255 cells?

Older versions of VTE do not support any modern mouse protocol. On top of that, the old X10 protocol it does implement is bugged. Through several workarounds we've managed to get the cell limit from 127 to 255. If you're not happy with this, you may want to look into using xterm or urxvt, or a terminal which uses a modern VTE, like gnome-terminal.

Is blessed efficient?

Yes. Blessed implements CSR and uses the painter's algorithm to render the screen. It maintains two screen buffers so it only needs to render what has changed on the terminal screen.

Will blessed work with all terminals?

Yes. blessed has a terminfo/termcap parser and compiler that was written from scratch. It should work with every terminal as long as a terminfo file is provided. If you notice any compatibility issues in your termial, do not hesitate to post an issue.

What is "curses" and "ncurses"?

"curses" was an old library written in the early days of unix which allowed a programmer to easily manipulate the cursor in order to render the screen. "ncurses" is a free reimplementation of curses. It improved upon it quite a bit by focusing more on terminal compatibility and is now the standard library for implementing terminal programs. Blessed uses neither of these, and instead handles terminal compatibility itself.

What is the difference between blessed and blessed-contrib?

blessed is a major piece of code which reimplements curses from the ground up. A UI API is then layered on top of this. blessed-contrib is a popular library built on top of blessed which makes clever use of modules to implement useful widgets like graphs, ascii art, and so on.

Are there blessed-like solutions for non-javascript platforms?

Yes. There are some fantastic solutions out there.
- Perl: Curses::UI
- Python: Urwid
- Go: termui & termbox-go

Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work. </legalese>

License

See LICENSE for more info.

58 KiB Raw Blame History

blessed

Important Blessed Changes (>0.0.51)

Install

Example

API Documentation

Widgets

Node (from EventEmitter)

Options:

Properties:

Events:

Methods:

Screen (from Node)

Options:

Properties:

Events:

Methods:

Element (from Node)

Options:

Properties:

Events:

Methods:

Content Methods

Box (from Element)

Options:

Properties:

Events:

Methods:

Text (from Element)

Options:

Line (from Box)

Options:

ScrollableBox (from Box)

Options:

Properties:

Events:

Methods:

ScrollableText (from ScrollableBox)

Options:

Properties:

Events:

Methods:

List (from Box)

Options:

Properties:

Events:

Methods:

Form (from Box)

Options:

Properties:

Events:

Methods:

Input (from Box)

Textarea (from Input)

Options:

Properties:

Events:

Methods:

Textbox (from Textarea)

Options:

Properties:

Events:

Methods:

Button (from Input)

Options:

Properties:

Events:

Methods:

ProgressBar (from Input)

Options:

Properties:

Events:

Methods:

FileManager (from List)

Options:

Properties:

Events:

Methods:

Checkbox (from Input)

Options:

58 KiB

Raw Blame History