https://github.com/olistic/inquirer-prompt-suggest

Inquirer.js prompt for your less creative users
https://github.com/olistic/inquirer-prompt-suggest

Last synced: over 1 year ago
JSON representation

Inquirer.js prompt for your less creative users

• Host: GitHub
• URL: https://github.com/olistic/inquirer-prompt-suggest
• Owner: olistic
• License: mit
• Created: 2018-05-22T18:36:52.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-12-22T08:52:13.000Z (over 4 years ago)
• Last Synced: 2024-06-20T05:48:38.629Z (about 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 35.2 KB
• Stars: 14
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# inquirer-prompt-suggest

[Inquirer.js](https://github.com/SBoudrias/Inquirer.js) prompt for your less

creative users.

![Preview](https://user-images.githubusercontent.com/5600126/40391192-d4f3d6d0-5ded-11e8-932f-4b75b642c09e.gif)

## Installation

```sh

npm install --save inquirer-prompt-suggest

```

## Usage

1.  Register the prompt:

```js

inquirer.registerPrompt('suggest', require('inquirer-prompt-suggest'));

```

2.  Use it:

```js

inquirer.prompt({

  type: 'suggest',

  name: 'kittenName',

  message: 'Enter a name for your kitten:',

  suggestions: ['Oliver', 'Luna', 'Charlie', 'Bella', 'Max', 'Lucy'],

});

```

## Options

Takes all [input properties](https://github.com/SBoudrias/Inquirer.js#input---type-input), plus:

* `suggestions` _(string[])_: A list of suggestions.

## License

MIT