embarklabs/neo-blessed
2
0
Fork 0
mirror of https://github.com/embarklabs/neo-blessed.git synced 2025-01-11 03:25:45 +00:00
Code Issues Projects Releases Wiki Activity

update and fix readme.

Browse Source
This commit is contained in:
Christopher Jeffrey 2015-07-21 19:35:19 -07:00
parent 96b917efe1
commit 5c51bfe412
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -336,8 +336,8 @@ The screen on which every other node renders.
replaced by `'??'`, `'?'`, `''` respectively. (NOTE: iTerm2 cannot display replaced by `'??'`, `'?'`, `''` respectively. (NOTE: iTerm2 cannot display
combining characters properly. Blessed simply removes them from an element's combining characters properly. Blessed simply removes them from an element's
content if iTerm2 is detected). content if iTerm2 is detected).
- __sendFocus__ - send focus events after mouse is enabled. - __sendFocus__ - Send focus events after mouse is enabled.
- __warnings__ - display warnings (such as the output not being a TTY, similar - __warnings__ - Display warnings (such as the output not being a TTY, similar
to ncurses). to ncurses).
##### Properties: ##### Properties:
@ -377,6 +377,8 @@ The screen on which every other node renders.
program.enableMouse(). program.enableMouse().
- __prerender__ - Received before render. - __prerender__ - Received before render.
- __render__ - Received on render. - __render__ - Received on render.
- __warning__ - Received when blessed notices something untoward (output is not
a tty, terminfo not found, etc).
##### Methods: ##### Methods:
@ -438,10 +440,10 @@ The screen on which every other node renders.
- __screenshot([xi, xl, yi, yl])__ - Take an SGR screenshot of the screen - __screenshot([xi, xl, yi, yl])__ - Take an SGR screenshot of the screen
within the region. Returns a string containing only characters and SGR codes. within the region. Returns a string containing only characters and SGR codes.
Can be displayed by simply echoing it in a terminal. Can be displayed by simply echoing it in a terminal.
- __destroy()__ - destroy the screen object and remove it from the global list. - __destroy()__ - Destroy the screen object and remove it from the global list.
only useful if using multiple screens. Only useful if using multiple screens.
- __program.destroy()__ - destroy the program object and remove it from the - __program.destroy()__ - Destroy the program object and remove it from the
global list. only useful if using multiple programs. global list. Only useful if using multiple programs.
#### Element (from Node) #### Element (from Node)