1.0.0 • Published 2 years ago

@developertheexplorer/expand v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@inquirer/expand

Compact single select prompt. Every option is assigned a shortcut key, and selecting h will expand all the choices and their descriptions.

Expand prompt closed Expand prompt expanded

Installation

npm install @inquirer/expand

yarn add @inquirer/expand

Usage

import expand from '@inquirer/expand';

const answer = await expand({
  message: 'Conflict on file.js',
  default: 'y',
  choices: [
    {
      key: 'y',
      name: 'Overwrite',
      value: 'overwrite',
    },
    {
      key: 'a',
      name: 'Overwrite this one and all next',
      value: 'overwrite_all',
    },
    {
      key: 'd',
      name: 'Show diff',
      value: 'diff',
    },
    {
      key: 'x',
      name: 'Abort',
      value: 'abort',
    },
  ],
});

Options

PropertyTypeRequiredDescription
messagestringyesThe question to ask
choicesArray<{ key: string, name: string, value?: string }>yesArray of the different allowed choices. The h/help option is always provided by default
defaultstringnoDefault choices to be selected. (value must be one of the choices key)
expandedbooleannoExpand the choices by default

License

Copyright (c) 2022 Simon Boudrias (twitter: @vaxilart) Licensed under the MIT license.