Absolute left offset, always zero.
Absolute right offset, always zero.
Absolute top offset, always zero.
Automatically position child elements with border and padding in mind (NOTE: this is a recommended option. It may become default in the future).
Relative bottom offset, always zero.
Same as screen.width.
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.
Instance of the debug console that is enabled when calling debug options is actuve and key f12 is pressed. Useful to programmatically access it in case keys don't wonk.
Automatically "dock" borders with other elements instead of overlapping, depending on position (experimental). For example: These border-overlapped elements:
Dump all output and input to desired file. Can be used together with log option if set as a boolean.
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.
If true, the node will obtain focus when m
Top of the focus history stack.
Force blessed to use unicode even if it is not detected via terminfo, env variables, or windows code page. If value is true unicode is forced. If value is false non-unicode is forced (default: null).
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).
Whether the focused element grabs all keypresses.
Height of the screen (same as program.rows).
The currently hovered element. Only set if mouse events are bound.
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.
Array of keys in their full format (e.g. C-c) to ignore when keys are locked or grabbed. Useful for creating a key that will always exit no matter whether the keys are locked.
Input and output streams. process.stdin/process.stdout by default, however, it could be a net.Socket if you want to make a program that runs over telnet or something of that nature.
Relative left offset, always zero.
Prevent keypresses from being received by any element.
Create a log file. See log method.
Input and output streams. process.stdin/process.stdout by default, however, it could be a net.Socket if you want to make a program that runs over telnet or something of that nature.
The blessed Program to be associated with. Will be automatically instantiated if none is provided.
Amount of time (in ms) to redraw the screen after the terminal is resized (Default: 300).
Relative right offset, always zero.
Same as screen.height.
Send focus events after mouse is enabled.
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.
The width of tabs within an element's content.
Set or get terminal name. Set calls screen.setTerminal() internally.
Set or get window title.
Relative top offset, always zero.
The blessed Tput object (only available if you passed tput: true to the Program constructor.)
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.
Display warnings (such as the output not being a TTY, similar to ncurses).
Width of the screen (same as program.cols).
Generated using TypeDoc
Absolute bottom offset, always zero.