Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kenan238/reblessed
A high-level terminal interface library for node.js.
https://github.com/kenan238/reblessed
Last synced: 9 days ago
JSON representation
A high-level terminal interface library for node.js.
- Host: GitHub
- URL: https://github.com/kenan238/reblessed
- Owner: kenan238
- License: mit
- Fork: true (chjj/blessed)
- Created: 2021-12-15T15:41:29.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-01T17:49:04.000Z (6 months ago)
- Last Synced: 2024-10-31T14:01:58.403Z (13 days ago)
- Language: JavaScript
- Homepage:
- Size: 12.7 MB
- Stars: 75
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# reblessed
#### If you'd like to request a feature, make a new issue
A curses-like library with a high level terminal interface API for node.js.
The library's official author, "chjj", seems to have abandoned the project, as the last commit was in 2016.
All forks have also died, so I took matters into my own hands and forked the project.
Blessed is a fantastic project, so I revived this masterpiece from the dead under the name "Re-Blessed", as I wasn’t able to find any other TUI libraries that had exactly what a TUI application needed!
## Install
### Latest release
``` bash
npm install reblessed
```
### Latest source code
``` bash
git clone [email protected]:kenan238/reblessed.git
```
## 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
`reblessed.screen` option. This will enable CSR when scrolling text in elements
or when manipulating lines.
``` js
const reblessed = require('reblessed');
// Create a screen object.
const screen = reblessed.screen({
smartCSR: true
});
screen.title = 'my window title';
// Create a box perfectly centered horizontally and vertically.
const box = reblessed.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
const icon = reblessed.image({
parent: box,
top: 0,
left: 0,
type: 'overlay',
width: 'shrink',
height: 'shrink',
file: __dirname + '/my-program-icon.png',
search: false
});
// If our box is clicked, change the content.
box.on('click', (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', (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'], (ch, key) => {
return process.exit(0);
});
// Focus our element.
box.focus();
// Render the screen.
screen.render();
```
## Documentation
Go to the WIKI tab
## 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. ``
## New license
See `LICENSE.md`
## Original License
Copyright (c) 2013-2015, Christopher Jeffrey. (MIT License)
See LICENSE for more info.