inquirer-select-pro

An inquirer select that supports multiple selections and filtering/searching.

Install

``bash
pnpm i inquirer-select-pro
`

`bash
npm i inquirer-select-pro
`

Try now?

`bash
npx @jeffwcx/gitignore
`

![asciicast](https://asciinema.org/a/658848)

> A CLI to generate a .gitignore file: @jeffwcx/gitignore.

Usage

$3

`ts
import { select } from 'inquirer-select-pro';
const answer = await select({
message: 'select',
options: async (input) => {
const res = await fetch('', {
body: new URLSearchParams({ keyword: input }),
});
if (!res.ok) throw new Error('fail to get list!');
return await res.json();
},
});
`

$3

`ts
import { select } from 'inquirer-select-pro';
const answer = await select({
message: 'select...',
mutiple: false,
options: [
{ name: 'Apple', value: 'apple' },
{ name: 'Banana', value: 'banana' },
],
});
`

$3

Clear the filter input when the option is selected (also causes the option list to change).

$3

The first time you try the delete key, it will focus on the option to be deleted, and the second time it will remove the focused option.

`ts
import { select } from 'inquirer-select-pro';
const answer = await select({
message: 'select',
confirmDelete: true,
options: async (input) => {
const res = await fetch('', {
body: new URLSearchParams({ keyword: input }),
});
if (!res.ok) throw new Error('fail to get list!');
return await res.json();
},
});
`

API

$3

An inquirer select that supports multiple selections and filtering

#### Parameters

- config _SelectProps_ _\_

#### Returns

_CancelablePromise_ _\_

#### Examples

`ts
import { select } from 'inquirer-select-pro';
const answer = await select({
message: 'select',
options: async (input) => {
const res = await fetch('', {
body: new URLSearchParams({ keyword: input }),
});
if (!res.ok) throw new Error('fail to get list!');
return await res.json();
},
});
`

$3

> [!WARNING]
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

#### Type

`typescript
declare function useSelect(
props: UseSelectOptions,
): UseSelectReturnValue;
`

#### Parameters

- props _UseSelectOptions__\_

#### Returns

_UseSelectReturnValue__\_

$3

#### Type

`ts
export type SelectTheme = {
prefix: string;
spinner: {
interval: number;
frames: string[];
};
icon: {
checked: string;
unchecked: string;
cursor: string;
inputCursor: string;
};
style: {
answer: (text: string) => string;
message: (text: string) => string;
error: (text: string) => string;
help: (text: string) => string;
highlight: (text: string) => string;
key: (text: string) => string;
disabledOption: (text: string) => string;
renderSelectedOptions: (
selectedOptions: ReadonlyArray>,
allOptions: ReadonlyArray | Separator>,
) => string;
emptyText: (text: string) => string;
placeholder: (text: string) => string;
};
helpMode: 'always' | 'never' | 'auto';
};
`

#### Examples

`ts
await renderPrompt({
message,
placeholder: 'search',
options: () => top100Films,
pageSize: 2,
instructions: false,
theme: {
icon: {
inputCursor: 'filter: ',
checked: ' √',
unchecked: ' ',
},
style: {
placeholder: (text: string) => ${text}...,
},
},
});
`

The appearance is as follows:

`
? Choose movie:
filter: The Shawshank Redemption (1994)
> √ The Shawshank Redemption (1994)
The Godfather (1972)

`

How to contribute？

1. Fork the project

2. Start development

`bash
git clone https://github.com/yourname/inquirer-select-pro.git
cd inquirer-select-pro
pnpm i


Create a branch

git checkout -b my-new-feature

Develop

pnpm dev

Build

pnpm build

Test

pnpm test
`

> [!NOTE]
> Running pnpm dev actually allows you to specify the demo directly.

Here is a list of available demos:

- local
- remote
- filter-remote
- filter-local

`bash
pnpm dev filter-remote
`

Parameters can also be fixed. The following parameters can be fixed:

- filter
- clearInputWhenSelected
- required
- loop
- multiple
- canToggleAll
- confirmDelete
- selectFocusedOnSubmit

`bash
pnpm dev filter-demo --multiple=false
`

3. Commit changes to your branch git commit -am 'Add some feature'

4. Push your branch git push origin my-new-feature`

5. Submit a pull request