# inquirer-table-prompt

> A table-like prompt for Inquirer

Latest version **0.2.1** (published 2020-01-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install inquirer-table-prompt
pnpm add inquirer-table-prompt
yarn add inquirer-table-prompt
bun add inquirer-table-prompt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2020-01-23 |
| First published | 2020-01-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Eduardo Bouças |
| Maintainers | eduardoboucas |
| Keywords | inquirer, cli, prompt |

## Links

- npm: https://www.npmjs.com/package/inquirer-table-prompt
- Repository: https://github.com/eduardoboucas/inquirer-table-prompt
- Homepage: https://github.com/eduardoboucas/inquirer-table-prompt#readme
- Issues: https://github.com/eduardoboucas/inquirer-table-prompt/issues
- npm.io page: https://npm.io/package/inquirer-table-prompt

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [figures](https://npm.io/package/figures.md) ^3.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.3
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [cli-cursor](https://npm.io/package/cli-cursor.md) ^3.1.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2020-01-23
- 0.2.0 — 2020-01-23
- 0.1.0 — 2020-01-14

## README

# inquirer-table-prompt [![npm version](https://badge.fury.io/js/inquirer-table-prompt.svg)](https://badge.fury.io/js/inquirer-table-prompt)

> A table-like prompt for [Inquirer.js](https://github.com/SBoudrias/Inquirer.js)

![Screen capture of the table prompt](screen-capture.gif)

## Installation

```
npm install --save inquirer-table-prompt
```

## Usage

After registering the prompt, set any question to have `type: "table"` to make use of this prompt.

The result will be an array, containing the value for each row.

```js
inquirer.registerPrompt("table", require("./index"));

inquirer
  .prompt([
    {
      type: "table",
      name: "workoutPlan",
      message: "Choose your workout plan for next week",
      columns: [
        {
          name: "Arms",
          value: "arms"
        },
        {
          name: "Legs",
          value: "legs"
        },
        {
          name: "Cardio",
          value: "cardio"
        },
        {
          name: "None",
          value: undefined
        }
      ],
      rows: [
        {
          name: "Monday",
          value: 0
        },
        {
          name: "Tuesday",
          value: 1
        },
        {
          name: "Wednesday",
          value: 2
        },
        {
          name: "Thursday",
          value: 3
        },
        {
          name: "Friday",
          value: 4
        },
        {
          name: "Saturday",
          value: 5
        },
        {
          name: "Sunday",
          value: 6
        }
      ]
    }
  ])
  .then(answers => {
    /*
    { workoutPlan:
      [ 'arms', 'legs', 'cardio', undefined, 'legs', 'arms', undefined ] }    
    */
    console.log(answers);
  });
```

### Options

- `columns`: Array of options to display as columns. Follows the same format as Inquirer's `choices`
- `rows`: Array of options to display as rows. Follows the same format as Inquirer's `choices`
- `pageSize`: Number of rows to display per page

---
_Source: https://npm.io/package/inquirer-table-prompt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._