Inquirer Checkbox Plus Prompt

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

📒 This fork modifies the original search behavior by hijacking Shift-A and Shift-I keypresses to trigger "toggle all" and "inverse selection" actions. This allows the user to filter down a long list, typically using non-case-sensitive matching, while also having the option to select all items. It also adds the summarize option, a function that returns a one-line summary of the checked choices in lieu of a possibly very long comma-separated list of values.

Installation

npm install --save 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.

inquirer.registerPrompt('checkbox-plus', require('inquirer-checkbox-plus-prompt'));

inquirer.prompt({
  type: 'checkbox-plus',
  ...
})

Options

Takes type, name, message, source[, filter, validate, default, pageSize, highlight, searchable, summarize] 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.
summarize: (Function) a method that takes an array of checked choices and returns a one-line summary in lieu of the default comma-separated list of short values.

Example

Check example.js for a more advanced example.

var inquirer = require('inquirer');
var fuzzy = require('fuzzy');

inquirer.registerPrompt('checkbox-plus', require('inquirer-checkbox-plus-prompt'));

var colors = ['red', 'green', 'blue', 'yellow'];

inquirer.prompt([{
  type: 'checkbox-plus',
  name: 'colors',
  message: 'Enter colors',
  pageSize: 10,
  highlight: true,
  searchable: true,
  default: ['yellow', 'red'],
  source: function(answersSoFar, input) {
    input = input || '';

    return new Promise(function(resolve) {
      var fuzzyResult = fuzzy.filter(input, colors);
      var data = fuzzyResult.map(function(element) {
        return element.original;
      });
      resolve(data);
    });
  },
  summarize: function(checkedChoices) {
    return checkedChoices.length + ' chosen';
  }
}])
.then(function(answers) {
  console.log(answers.colors);
});

License

This project is under the MIT license.

erhhung / inquirer-checkbox-plus-prompt