Skip to content

RecuencoJones/inquirer-ordinal-prompt

Repository files navigation

npm version Build

inquirer-ordinal-prompt

Ordinal prompt for inquirer

Installation

npm install --save inquirer inquirer-ordinal-prompt

Usage

inquirer.registerPrompt('ordinal', require('inquirer-ordinal-prompt').default);

inquirer.prompt({
  type: 'ordinal',
  name: 'scripts',
  message: 'Pick scripts to run in order',
  choices: [ 'Build', 'Lint', 'Test' ],
  default: [ 'Build' ]
});

Options

Take type, name, message, choices[, filter, validate, default] properties. default is expected to be an Array of the ordered choices value.

ordinal prompt is mostly the same as checkbox prompt, with slight differences:

  • it doesn't use checked property and instead leverages default as an ordered list of choice values.
  • selecting a choice will show ordinal index instead of filled checkbox.

Example

You can find a running example in demo.js

asciicast