readline-ui

readline-ui

Create readline interface to use in prompts.

Install

Install with npm:

$ npm install --save readline-ui

Usage

var UI = require('readline-ui');
var ui = new UI();

API

.render

Render the given str in the terminal, and optional bottomContent.

Params

• str {String}
• bottomContent {String}
• returns {undefined}

.clearLines

Remove n lines from the bottom of the terminal

Params

• lines {Number}: Number of lines to remove

Attribution

Inspired by the "screen manager" code in Inquirer.

About

Related projects

• enquirer: Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… more | homepage
• prompt-choices: Create an array of multiple choice objects for use in prompts. | homepage
• prompt-question: Question object, used by Enquirer and prompt plugins. | homepage
• readline-utils: Readline utils, for moving the cursor, clearing lines, creating a readline interface, and more. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on May 09, 2017.