$ npm install choices-separator
Separator for choices arrays in prompts. Based on the Separator from inquirer.
Install with npm:
$ npm install --save choices-separator
var Separator = require('choices-separator');
var Prompt = require('prompt-checkbox');
var prompt = new Prompt({
message: 'Which do you prefer?',
name: 'favorites',
choices: [
new Separator(' = Color = '),
{name: 'red'},
{name: 'yellow', checked: true },
{name: 'blue'},
new Separator(' = Shape = '),
{name: 'circle'},
{name: 'triangle'},
{name: 'square'}
]
});
prompt.run()
.then(function(answer) {
console.log(answer)
});
Separator object, used in choices arrays in prompts, to create a visual break between sections. The default separator line is ────────
styled with ansi-dim.
Params
options
{String}: Optionally provide a custom line
and or prefix
to use.Example
new Separator('----');
new Separator({line: '----'})
new Separator({line: '----', prefix: ' '});
Returns the separator.line
stripped of ansi styling.
returns
{String}Example
var separator = new Separator();
console.log(separator.raw());
//=> '────────'
Render separator.prefix
plus separator.line
.
returns
{String}Example
var separator = new Separator();
console.log(separator.render());
//=> ' \u001b[2m────────\u001b[22m\n')
Returns false if the given object is a separator.
Params
choice
{Object}: object to test againstreturns
{Boolean}: Returns false if the given object is a separatorStringify separator
returns
{String}: Returns the separator.line
stringOriginally inspired by the Separator
class from Inquirer.
enquirer: Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(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 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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 17, 2017.
© 2010 - cnpmjs.org x YWFE | Home | YWFE