@developertheexplorer/checkbox NPM

`@inquirer/checkbox`

Simple interactive command line prompt to display a list of checkboxes (multi select).

Checkbox prompt

Installation

npm install @inquirer/checkbox

yarn add @inquirer/checkbox

Usage

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 },
  ],
});

Options

Property	Type	Required	Description
message	`string`	yes	The question to ask
choices	`Array<{ value: string, name?: string, disabled?: 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

cli prompt command-line input inquirer

@inquirer/core chalk figures

@infinitebrahmanuniverse/nolb-_deve @everything-registry/sub-chunk-237

1.0.0

2 years ago