# inquirer-checkbox-plus

> better inquirer-checkbox-plus-prompt

Latest version **1.0.2** (published 2018-12-06) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-12-06 |
| First published | 2018-07-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 104.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Y.V |
| Maintainers | yungvenuz |
| 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-checkbox-plus
- Repository: https://github.com/yviscool/inquirer-checkbox-plus
- Homepage: https://github.com/yviscool/inquirer-checkbox-plus#readme
- Issues: https://github.com/yviscool/inquirer-checkbox-plus/issues
- npm.io page: https://npm.io/package/inquirer-checkbox-plus

## Dependencies (1)

- [inquirer](https://npm.io/package/inquirer.md) ^6.0.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.2 (latest) — 2018-12-06
- 1.0.1 — 2018-07-23
- 1.0.0 — 2018-07-22
- 0.9.9 — 2018-07-21
- 0.9.8 — 2018-07-07

## README

# inquirer-checkbox-plus
 Inspired by [inquirer-checkbox-plus-prompt](https://github.com/faressoft/inquirer-checkbox-plus-prompt)


### Installation

``` shell
npm install inquirer-checkbox-plus
```

### Usage

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

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

### options

Takes `type`, `name`, `message`, `source`[, `filter`, `validate`, `default`, `pageSize`, `highlight`, `searchable`, `enablebackspace`, `answer`,`footer`,`header`,`keypress`,`searching`,`noresult`] properties.

* **highlight**:  (Function/Boolean)
* **answer**:  (Function)
* **header**: (Function/String)
* **footer**: (Function/String)
* **searching**: (Function/String)
* **noresult**: (Function/String)
* **enablebackspace**: (Boolean) If `true`, backspace will not emit `keypress` event
* **keypress** : (Function), args (events, validation, prompt), events is a observable which can bind any keypress event, validation is observable which can be used with events, prompt is this 

see `example.js`

### category 


![demo](https://github.com/yviscool/inquirer-checkbox-plus/blob/master/demo.gif)


Do not enable `searchable` options.


```javascript
inquirer.prompt([{
    type: 'checkbox-plus',
    ...
    source: function (answersSoFar, input) {

        return Promise.resolve(...)

    },
    subsource: function (choice, type) {
    	...
        return Promise.resolve([])
    }
}])atch(console.log)
```

use `gg/G` key to return the top/bottom. `h/l` key to change the cagetory.

see `example01.js`

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