inquirer-table-checkbox

A checkbox prompt (as a multi-column table) for Inquirer.js

Based off inquirer-table-prompt

Installation

1npm install --save @adobe/inquirer-table-checkbox

Usage

1const inquirer = require("inquirer")
2const inquirerTableCheckbox = require("@adobe/inquirer-table-checkbox")
3inquirer.registerPrompt("table", inquirerTableCheckbox)
4
5inquirer
6  .prompt([
7    {
8      type: "table",
9      name: "article",
10      bottomContent: "visit Wikipedia",
11      message: "Choose the article you want",
12      wordWrap: true,
13      pageSize: 2,
14      style: { "padding-left": 1, "padding-right": 0, head: [], border: [] },
15      colWidths: [30, 50],
16      columns: [
17        {
18          name: "URL",
19          wrapOnWordBoundary: false
20        },
21        {
22          name: "Description",
23          wrapOnWordBoundary: true
24        }
25      ],
26      rows: [
27        {
28          value: "voyager",
29          URL: "https://en.wikipedia.org/wiki/Voyager_program",
30          Description:
31            "The Voyager program is an American scientific program that employs two robotic interstellar probes, Voyager 1 and Voyager 2. They were launched in 1977 to take advantage of a favorable alignment of Jupiter and Saturn, to fly near them while collecting data for transmission back to Earth. After launch the decision was taken to send Voyager 2 near Uranus and Neptune to collect data for transmission back to Earth."
32        },
33        {
34          value: "spacex",
35          URL: "https://en.wikipedia.org/wiki/SpaceX",
36          Description:
37            "Space Exploration Technologies Corp. (doing business as SpaceX) is an American spacecraft manufacturer, space launch provider, and a satellite communications corporation headquartered in Hawthorne, California. SpaceX was founded in 2002 by Elon Musk, with the goal of reducing space transportation costs to enable the colonization of Mars. SpaceX manufactures the Falcon 9 and Falcon Heavy launch vehicles, several rocket engines, Cargo Dragon, crew spacecraft, and Starlink communications satellites.",
38          disabled: true
39        },
40        {
41          value: "starlink",
42          URL: "https://en.wikipedia.org/wiki/Starlink",
43          Description:
44            "Starlink is a satellite internet constellation operated by SpaceX, providing satellite Internet access coverage to 40 countries. It also aims for global mobile phone service after 2023. SpaceX started launching Starlink satellites in 2019. As of September 2022, Starlink consists of over 3,000 mass-produced small satellites in low Earth orbit (LEO), which communicate with designated ground transceivers. In total, nearly 12,000 satellites are planned to be deployed, with a possible later extension to 42,000. Starlink provides internet access to over 500,000 subscribers as of June 2022."
45        },
46        {
47          value: "adobe",
48          URL: "https://en.wikipedia.org/wiki/Adobe_Inc.",
49          Description:
50            "Adobe Inc., originally called Adobe Systems Incorporated, is an American multinational computer software company incorporated in Delaware and headquartered in San Jose, California. It has historically specialized in software for the creation and publication of a wide range of content, including graphics, photography, illustration, animation, multimedia/video, motion pictures, and print. Its flagship products include Adobe Photoshop image editing software; Adobe Illustrator vector-based illustration software; Adobe Acrobat Reader and the Portable Document Format (PDF); and a host of tools primarily for audio-visual content creation, editing and publishing. Adobe offered a bundled solution of its products named Adobe Creative Suite, which evolved into a subscription software as a service (SaaS) offering named Adobe Creative Cloud. The company also expanded into digital marketing software and in 2021 was considered one of the top global leaders in Customer Experience Management (CXM)."
51        }
52      ]
53    }
54  ])
55  .then(answers => {
56    console.log(answers)
57  })

Table Options

Key	Type (default)	Description
name	string	the string key to use for the answers returned from the prompt
bottomContent	string	the text to show at the bottom of the table
message	string	the text to show at the top of the table
wordWrap	boolean (false)	set to true whether to wordWrap items in the table
wrapOnWordBoundary	boolean (true)	set to false if you don't want to wrap on a word boundary.
		Only applies when wordWrap is true.
pageSize	integer (5)	the number of rows to show per page
style	object	see https://github.com/cli-table/cli-table3 for styles to apply
colWidths	array<integer>	size of each column in columns
columns	array<Column>	see Column
rows	array<Row>	see Row

Column

Each Column is an object with these keys:

Key	Type	Description
name	string	the key for the Column (to be used in a Row)
wordWrap (optional)	boolean	set if you want to override the table option
wrapOnWordBoundary (optional)	boolean	set if you want to override the table option

Row

Each Row is an object with these keys:

Key	Type	Description
value	any	this is the value to be returned if the row was selected
disabled	boolean	display the option, but do not allow the user to select it
ColumnName	string	for each column name (see Column section above),
		set the key as the column name and the value as the column contents for the row.