Package Exports
- @inquirer/checkbox
Readme
@inquirer/checkbox
Simple interactive command line prompt to display a list of checkboxes (multi select).
Installation
npm install @inquirer/checkbox
yarn add @inquirer/checkboxUsage
import checkbox from '@inquirer/checkbox';
const answer = await checkbox({
message: 'Select a package manager',
choices: [
{ name: 'npm', value: 'npm' },
{ name: 'yarn', value: 'yarn' },
{ name: 'pnpm', value: 'pnpm', disabled: true },
{
name: 'pnpm',
value: 'pnpm',
disabled: '(pnpm is not available)',
},
],
});Options
| Property | Type | Required | Description |
|---|---|---|---|
| message | string |
yes | The question to ask |
| choices | Array<{ value: string, name?: string, disabled?: boolean | string, checked?: boolean }> |
yes | List of the available choices. The value will be returned as the answer, and used as display if no name is defined. Choices who're disabled will be displayed, but not selectable. |
License
Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.