example.js

/**
 * Checkbox Plus Example
 * 
 * @author Mohammad Fares <faressoft.com@gmail.com>
 */

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

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

var colors = [
  {name: 'The red color', value: 'red', short: 'red', disabled: false},
  {name: 'The blue color', value: 'blue', short: 'blue', disabled: true},
  {name: 'The green color', value: 'green', short: 'green', disabled: false},
  {name: 'The yellow color', value: 'yellow', short: 'yellow', disabled: false},
  {name: 'The black color', value: 'black', short: 'black', disabled: false}
];

inquirer.prompt([{
  type: 'checkbox-plus',
  name: 'colors',
  message: 'Enter colors',
  pageSize: 10,
  highlight: true,
  searchable: true,
  default: ['yellow', 'red', {name: 'black'}],
  validate: function(answer) {

    if (answer.length == 0) {
      return 'You must choose at least one color.';
    }

    return true;

  },
  source: function(answersSoFar, input) {

    input = input || '';

    return new Promise(function(resolve) {

      var fuzzyResult = fuzzy.filter(input, colors, {
        extract: function(item) {
          return item['name'];
        }
      });

      var data = fuzzyResult.map(function(element) {
        return element.original;
      });

      resolve(data);
      
    });

  }
}]).then(function(answers) {

  console.log(answers.colors);

});