@inquirer/expand
TypeScript icon, indicating that this package has built-in type declarations

2.1.10 • Public • Published

@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

Property Type Required Description
message string yes The question to ask
choices Array<{ key: string, name: string, value?: string }> yes Array of the different allowed choices. The h/help option is always provided by default
default string no Default choices to be selected. (value must be one of the choices key)
expanded boolean no Expand the choices by default
theme See Theming no Customize look of the prompt.

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type Theme = {
  prefix: string;
  spinner: {
    interval: number;
    frames: string[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string) => string;
    error: (text: string) => string;
    defaultAnswer: (text: string) => string;
    highlight: (text: string) => string;
  };
};

License

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

Package Sidebar

Install

npm i @inquirer/expand

Weekly Downloads

279,393

Version

2.1.10

License

MIT

Unpacked Size

17.6 kB

Total Files

8

Last publish

Collaborators

  • sboudrias
  • danielchatfield
  • mischah