Inquirer Checkbox Plus Prompt

A plugin for Inquirer, similar to the original checkbox with extra features.

Installation

npm install -g inquirer-checkbox-plus-prompt

Usage

You can name it with any name other than checkbox-plus, just change the string 'checkbox-plus' to anything else.

1inquirer.registerPrompt('checkbox-plus', require('inquirer-checkbox-plus-prompt'));
2
3inquirer.prompt({
4  type: 'checkbox-plus',
5  ...
6})

Options

Takes type, name, message, source[, filter, validate, default, pageSize, highlight, searchable] properties.

The extra options that this plugin provides are:

• source: (Function) a method that called to return a promise that should be resolved with a list of choices in a similar format as the choices option in the original checkbox prompt of Inquirer.
• highlight: (Boolean) if true, the current selected choice gets highlighted. Default: false.
• searchable: (Boolean) if true, allow the user to filter the list. The source function gets called everytime the search query is changed. Default: false.

Example

Check example.js for a more advanced example.

1var inquirer = require('inquirer');
2var fuzzy = require('fuzzy');
3
4inquirer.registerPrompt('checkbox-plus', require('./index'));
5
6var colors = ['red', 'green', 'blue', 'yellow'];
7
8inquirer.prompt([{
9  type: 'checkbox-plus',
10  name: 'colors',
11  message: 'Enter colors',
12  pageSize: 10,
13  highlight: true,
14  searchable: true,
15  default: ['yellow', 'red'],
16  source: function(answersSoFar, input) {
17
18    input = input || '';
19
20    return new Promise(function(resolve) {
21
22      var fuzzyResult = fuzzy.filter(input, colors);
23
24      var data = fuzzyResult.map(function(element) {
25        return element.original;
26      });
27
28      resolve(data);
29      
30    });
31
32  }
33}]).then(function(answers) {
34
35  console.log(answers.colors);
36
37});

License

This project is under the MIT license.