Inquirer TypeScript Checkbox Plus Prompt

A plugin for Inquirer, similar to the original checkbox with extra features. This project is TypeScript port from inquirer-checkbox-plus-prompt

Installation

1npm install inquirer-ts-checkbox-plus-prompt

Usage

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

1import { CheckboxPlusPrompt } from 'inquirer-ts-checkbox-plus-prompt';
2
3inquirer.registerPrompt('checkbox-plus', CheckboxPlusPrompt);
4
5inquirer.prompt({
6  type: 'checkbox-plus',
7  ...
8})

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.ts for a more advanced example.

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

License

This project is under the MIT license.