# inquirer-ts-checkbox-plus-prompt

> Checkbox with autocomplete and other additions for Inquirer

Latest version **1.0.1** (published 2022-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install inquirer-ts-checkbox-plus-prompt
pnpm add inquirer-ts-checkbox-plus-prompt
yarn add inquirer-ts-checkbox-plus-prompt
bun add inquirer-ts-checkbox-plus-prompt
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-10-27 |
| First published | 2022-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 31.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | ByungJoon Lee |
| Maintainers | jooni |
| Keywords | inquirer, checkbox, autocomplete, search, filter, searchable, highlight, source, api, promise, command, prompt, stdin, cli, tty, menu |

## Links

- npm: https://www.npmjs.com/package/inquirer-ts-checkbox-plus-prompt
- Repository: https://github.com/imjuni/inquirer-ts-checkbox-plus-prompt
- Homepage: https://github.com/imjuni/inquirer-ts-checkbox-plus-prompt#readme
- Issues: https://github.com/imjuni/inquirer-ts-checkbox-plus-prompt/issues
- npm.io page: https://npm.io/package/inquirer-ts-checkbox-plus-prompt

## Dependencies (5)

- [rxjs](https://npm.io/package/rxjs.md) ^7.5.7
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [figures](https://npm.io/package/figures.md) ^3.2.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.5
- [cli-cursor](https://npm.io/package/cli-cursor.md) ^3.1.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-10-27
- 1.0.0 — 2022-10-27

## README

# Inquirer TypeScript Checkbox Plus Prompt

A plugin for [Inquirer](https://github.com/SBoudrias/Inquirer.js), similar to the original checkbox with extra features. This project is TypeScript port from [inquirer-checkbox-plus-prompt](https://github.com/faressoft/inquirer-checkbox-plus-prompt)

[![npm](https://img.shields.io/npm/v/inquirer-ts-checkbox-plus-prompt.svg)](https://www.npmjs.com/package/inquirer-ts-checkbox-plus-prompt)
[![npm](https://img.shields.io/npm/l/inquirer-ts-checkbox-plus-prompt.svg)](https://github.com/faressoft/inquirer-ts-checkbox-plus-prompt/blob/master/LICENSE)

![Demo](/demo.gif?raw=true)

## Installation

```bash
npm install -g 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.

```js
import { CheckboxPlusPrompt } from 'inquirer-ts-checkbox-plus-prompt';

inquirer.registerPrompt('checkbox-plus', CheckboxPlusPrompt);

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

## 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](/example.ts?raw=true) for a more advanced example.

```ts
import fuzzy from 'fuzzy';
import inquirer from 'inquirer';
import CheckboxPlusPrompt from '../lib/CheckboxPlusPrompt';

inquirer.registerPrompt('checkbox-plus', CheckboxPlusPrompt);

const 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(answersSoFar, input) {
        input ||= '';

        return new Promise((resolve) => {
          const fuzzyResult = fuzzy.filter(input, colors);

          const data = fuzzyResult.map((element) => {
            return element.original;
          });

          resolve(data);
        });
      },
    },
  ])
  .then((answers) => {
    console.log(answers.colors);
  });
```

## License

This project is under the MIT license.

---
_Source: https://npm.io/package/inquirer-ts-checkbox-plus-prompt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._