Enquirer-prompt-checkbox NPM

enquirer-prompt-checkbox

Adds multiple-choice/checkbox prompt support to Enquirer.

checkbox prompt example

Install

Install with npm:

$ npm install --save enquirer-prompt-checkbox

Usage

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('checkbox', require('enquirer-prompt-checkbox'));

Example

Enquirer supports both the declarative inquirer-style question format and a functional format using the .question method:

.question

Functional style questions.

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('checkbox', require('enquirer-prompt-checkbox'));
enquirer.question('color', 'What is your favorite color?', {
  type: 'checkbox',
  default: 'blue',
  choices: ['red', 'yellow', 'blue']
});

enquirer.ask('color')
  .then(function(answers) {
    console.log(answers)
  });

Inquirer-style questions

Declarative questions format.

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('checkbox', require('enquirer-prompt-checkbox'));

var questions = [
  {
    name: 'color',
    message: 'What is your favorite color?',
    type: 'checkbox',
    default: 'blue',
    choices: ['red', 'yellow', 'blue']
  }
];

enquirer.ask(questions)
  .then(function(answers) {
    console.log(answers)
  });

Attribution

Based on the checkbox prompt in inquirer.

About

Related projects

enquirer-prompt: Base prompt module used for creating custom prompt types for Enquirer. | homepage
enquirer-question: Question object, used by Enquirer and prompt plugins. | homepage
enquirer: Plugin-based prompt system for node.js | homepage