reblessed
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

reblessed

If you'd like to request a feature, make a new issue.

Because the original blessed repo is kinda dead, (last commit in 2016) i decided to revive it.

reblessed-npm reblessed-stars reblessed-forks reblessed-stars reblessed-issues

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

reblessed

The library's official author "chjj" forgot about blessed the original library, the library has been dead for several years (from 2016!) and all forks also died, so I took matters on my own hands and forked the project.

Blessed is a cool project and so I revived this masterpiece from the dead under the name "Re-Blessed", because I could find no other TUI library that had exactly what a TUI application needed!

Install

Latest release

$ npm install reblessed

Latest source code

$ git remote add origin git@github.com:kenan238/reblessed.git
$ git pull origin master

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.

var blessed = require('reblessed');

// Create a screen object.
var screen = blessed.screen({
  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
var icon = blessed.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', 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();

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. </legalese>

New license

See LICENSE.md

Original License

Copyright (c) 2013-2015, Christopher Jeffrey. (MIT License)

See LICENSE for more info.

Package Sidebar

Install

npm i reblessed

Weekly Downloads

414

Version

0.2.1

License

MIT

Unpacked Size

1.6 MB

Total Files

162

Last publish

Collaborators

  • kenan238