npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nblessed

v1.0.0

Published

A high-level terminal interface library for node.js.

Downloads

8

Readme

nblessed

🖥✨ Creating CLI apps with great UI using JS.

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

Issues contributions welcome MIT license

nblessed

nblessed is an updated fork of blessed. The name is a reference to ncurses the updated version of curses. It is over 16,000 lines of code & terminal goodness completely implemented in javascript. Its goals are:

  1. Implement an easy to use widget API which is optimized for terminals.
  2. Be compatible with any terminal by, like ncurses, parsing and compiling terminfo and termcap, and outputting universal escape sequences.

Install

$ npm install nblessed

How It Works

The nblessed renderer makes use of the change-scroll-region (CSR) feature of terminals as well as back-color-erase (BCE). It draws the screen using the painter's algorithm and a screen damange buffer and smart cursor movements. This means rendering will be extremely efficient: nblessed only draws the changes.

nblessed should be as accurate as ncurses, but even more optimized in some ways. The widget library gives you an API which is reminiscent of the DOM. Anyone is able to make an awesome terminal application with nblessed.

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 nblessed.screen option. This will enable CSR when scrolling text in elements or when manipulating lines.

import nblessed from "nblessed";

// Create a screen object.
const screen = nblessed.screen({
  // Recommend to use either `smartCSR` or `fastCSR` as it
  // will make scrolling text in elements much cleaner.
  smartCSR: true
});

screen.title = 'My Amazing CLI App';

// Create a box perfectly centered horizontally and vertically.
const box = nblessed.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 = nblessed.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();

Known Issues

  • Currently there is no mouse or resize event support on Windows.

Testing

Tests are contained in the ./test/ directory are interactive. If you intend to sumbit a PR please write tests! See CONTRIBUTING.md for more info.

Examples

Examples can be found in ./examples/.

License

Licenced under the MIT License. See the LICENSE file for more info.