Interactive table component for command line interfaces.
Choose between choices? (Press <space> to select, <Up and Down> to move rows, <Left and Right> to move columns) ┌──────────┬────────┬────────┐ │ 1-2 of 2 │ Yes? │ No? | ├──────────┼────────┼────────┤ │ Choice 1 │ [ ◯ ] │ ◯ | ├──────────┼────────┼────────┤ │ Choice 2 │ ◯ │ ◯ | └──────────┴────────┴────────┘
npm install @bartheleway/inquirer-table-multiple yarn add @bartheleway/inquirer-table-multiple
import tableMultiple from '@bartheleway/inquirer-table-multiple'
const answer = await tableMultiple({
message: 'Choose between choices?',
columns: [
{
title: 'Yes?'
value: 1,
},
{
title: 'No?'
value: 0,
},
],
rows: [
{
value: 1,
title: 'Choice 1',
},
{
value: 2,
title: 'Choice 2',
}
],
}) Property Type Required Description Default allowUnset boolean no If multiple is set to false and this one to true, you can unselect the selected choice. false columns (TableQuestionColumn<Value> | TableColumn)[] yes The list of columns to display. ignoreEmptyAnswers boolean no Indicate if validate, sumUp and output contains rows with no answers or not. true loop boolean no Indicate if you can loop over table rows. true message string yes The question to ask. multiple boolean no Indicate if rows allows multiple choices or not. false pageSize number no The number of lines to display. 7 required boolean no Indicate if at least one choice is necessary. false rows (TableRow | Separator)[] yes The list of rows. Each row offer a choice which can be multiple (radio vs checkbox vs checkbox-multi) based on the mode option. sumUp TableAnswers<Value> => string no This allow to display a resume of selected answers to user after validation. validate TableAnswers<Value> => boolean | string | Promise<string | boolean> no On submit, validate the answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash.
Column definition will be used to make the header row of the table.
You can have addition information column by using TableQuestionColumn<Value>with an object attribute name of the value used in rows. In this case, value of TableRow must be an object.
type TableColumn = {
title: string,
value: string | number | undefined,
}
type TableQuestionColumn<Value> = {
title: string,
rowAttributeTarget: keyof Value,
}
Row definition will be used to generate each rows of the table. A disabled row will display as usual but without any selectable choice.
title will be used as first column label to differenciate each row.
A separator will span over all columns and display its separator param.
type TableRow<Value> = {
title: string,
value: Value,
disabled?: boolean,
default?: (string | number)[]
}
This inquirer prompt will return an array. Each responded row will contains the row value (choice) along with selected answers. By default only rows with answers will be returned, you can change this with ignoreEmptyAnswers: false
type TableAnswers<Value> = TableAnswer<Value>[]
type TableAnswer<Value> = {
choice: TableRow<Value>[],
answers: (string | number)[],
}
You can have a look to tests files to look for advanced usage.
Some OS doesn't trim test result lines so you can set an environment variable FIX_OS_EXTRA_SPACE=1 to fix that and enable having consistent result with local & remote runner.
The simpliest way is to replace test entry value in package.json with FIX_OS_EXTRA_SPACE=1 && vitest.
Copyright (c) 2024 Bartheleway Licensed under the MIT license.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4