neo-blessed/CHANGELOG.md

84 lines
3.1 KiB
Markdown
Raw Normal View History

2015-04-10 20:01:12 +00:00
# Blessed v0.1.0 - new terminal goodies for node.js
2015-04-10 21:29:44 +00:00
![blessed](https://raw.githubusercontent.com/chjj/blessed/master/img/v0.1.0-3.gif)
2015-04-10 21:25:56 +00:00
The features demonstrated in the above gif __element transparency/shadow__ and
__border docking__.
2015-04-10 20:01:12 +00:00
## New useful options for your typewriter application:
2015-04-10 21:25:56 +00:00
- __`transparent` option__ - Lower element opacity to 50%. This will display
dimmed elements and content behind the foreground element using a naive color
blending function (good enough for a terminal's limited amount of colors).
works best with 256color terminals. (see widget-shadow.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`shadow` option__ - Give the element a translucent shadow. Automatically
darkens the background behind it. (see widget-shadow.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`dockBorders` option__ - Element borders will automatically "dock" to each
other. Instead of overlapping the borders end up connecting. (see
widget-dock.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`autoPadding` default__ - Auto padding is now enabled by default, meaning
blessed will automatically position elements inside their parent's border.
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`rleft` property__ - Relative offsets are now default element properties
(`left` instead of `rleft`).
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`draggable` property__ - Make any element draggable with the mouse. (see
widget-shadow.js or widget-dock.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`Table` and `ListTable` elements__ - Tables with a high quality rendering.
(see widget-table.js and widget-listtable.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`Log` element__ - A top to bottom logger box with scrollback and other
features. (see widget-log.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __Obscurable borders__ - In addition to docking borders, it's possible to
obscure borders by sliding them off the screen with negative offsets. (see
widget-dock.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __Percentage expressions__ - Like CSS, arithmetic can now be performed on
percentages. e.g. `width: '50%-1'`. This is useful for overlapping borders on
elements with a percentage width. (see widget-dock.js)
2015-04-10 20:01:12 +00:00
## Other features that weren't mentioned before:
2015-04-10 21:25:56 +00:00
- __`setHover` option__ - Set a hover text box to follow cursor on mouseover,
similar to how a web browser handles the "title" attribute. (see widget.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`Terminal` element__ - Spin up a pseudo terminal as a blessed element.
useful for writing a terminal multiplexer. (requires term.js and pty.js as
optional dependencies). (see example/multiplex.js)
2015-04-10 20:01:12 +00:00
2015-04-10 21:25:56 +00:00
- __`Image` element__ - Uses `w3mimgdisplay` to draw real images your terminal.
this is much easier than calling w3mimgdisplay by hand. Image elements behave
like any other element, although it is wise to use `width: 'shrink', height:
'shrink'`. (see widget-image.js)
2015-04-10 20:01:12 +00:00
---
2015-04-10 21:25:56 +00:00
The major things that justified the 0.1.0 release were fixes and stabilization
of api (`autoPadding`/`rleft`/`left`). Scrolling boxes were almost completely
revamped to work a bit smarter.
2015-04-10 20:01:12 +00:00
---
## Things yet to come:
2015-04-10 21:25:56 +00:00
- __@secrettriangle's [improvements](https://github.com/slap-editor/slap) for
textareas__ - This allows for real text navigation.
2015-04-10 20:01:12 +00:00
- __Gravity and margin layouts__
This is something that's been in the idea bin for a while. Every element could
potentially have properties like:
```
gravity: 'bottomleft',
margin: 5,
``
In other words, just a more complex `float` system than what the CSSOM is used
to.