Enquirer Cheatsheet

Terminology

API

Keypresses
Properties
Methods
Options
State
Status
Events

State and Status

state - The state contains the necessary properties for rendering each part of a prompt in the terminal.
status - A prompt's status is either pending, answered, or cancelled.

Styling

Styles - Styles are the semantic colors used consistently throughout the prompts.
Symbols - Unicode symbols
Elements - Elements combine styles, unicode symbols, and text for the various parts of a prompt.
Transforms - Transforms are responsible for formatting user input based on prompt state and status.
Themes

❯ Elements

An element is a functions that is responsible for combining the styles, text and unicode symbols to display for a specific part of prompt, based on prompt's state and status.

prefix message separator indicator

❯ Transforms

objects that consist of a render function and a result function. based on the state and status of the prompt.

❯ Terminology

Whenever possible, we attempted to use familiar concepts and terminology from HTML/CSS to describe prompt behavior and attributes.

term	description
`focused`	The currently targeted choice in a visible list of choices. Similar in concept to focus in HTML and CSS.
`pointer`	Marks the choice that currently has focus. The `❯` symbol is often used for this, but the pointer is not always visible, as with the `autocomplete` prompt.
`indicator`	Designates whether or not a choice is checked/enabled.
`index`	The zero-based position of the pointer in the visible list of choices.
`cursor`	The zero-based position of the cursor relative to user input.
`selected`	The position of the currently choice.
`enabled`	The position of the currently choice.
`active`	The position of the currently choice.
`element`	Elements are the various parts of a prompt. An element may consist of styles, text and unicode symbols.

❯ Keypresses

TODO - insert keypresses here.

<hr>

❯ Properties

Getters

term	description
`prompt.focused`	Gets the currently selected choice. Equivalent to `prompt.choices[prompt.index]`.

<hr>

❯ Methods

term	description
`focus`	Sets focus on the specified choice, if it can be focused.

<hr>

❯ Options

name	type	default	description
`stdin`	`stream`	`process.stdin`	The input stream to use for emitting keypress events.
`stdout`	`stream`	`process.stdout`	The output stream to use for writing the prompt to the terminal.
`autofocus`	`string	number`	`undefined`

<hr>

❯ State

<hr>

❯ Styles

Styles are semantically-named functions that may be used for adding color (via ANSI style codes) to the various elements of a prompt.

Default palette

Name	Default colors	Description
`primary`	`cyan`	Used on the prompt indicator, choice pointers, and to style user input (the "answer") in the terminal after it's submitted.
`danger`	`red`	Used on error messages.
`strong`	`bold`	Used on the user-defined prompt message
`success`	`green`	Used on enabled choice indicators.
`warning`	`yellow`	Not used.
`muted`	`dim`	Used on hints.
`disabled`	`gray`	Used on disabled choice messages.
`dark`	`dim.gray`	Used by other styles.
`default`	`noop` (no styling is applied)	Not used.
`info`	`styles.primary`	Used by the confirm prompt for styling user-input.
`inverse`	Inverse of `styles.primary`	Not used.
`complement`	Complement of `styles.primary`	Not used.
`answered`	`styles.primary`	Used in several prompts to style user input after submitted.
`cancelled`	`styles.danger`	Used to style the prompt prefix when the prompt is cancelled.
`completing`	`styles.default`	Not used.
`pending`	`styles.default`	Not used.
`on`	`styles.success`	Used on checked choice indicators.
`off`	`styles.dark`	Used on unchecked choice indicators (radio buttons, checkboxes, check marks, etc.)
`active`	`styles.primary`
`selected`	`styles.active.underline`
`placeholder`	`styles.primary.dim`
`highlight`	`styles.inverse`

The [ansi-colors][] library is used to apply styling.

Applying styles

If you are a prompt author, styles may be accessed using prompt.styles (or this.styles inside a prompt instance), where each "style" is a function that wraps the returned string in ANSI codes.

<hr>

❯ Events

Event	Description
`state`	A clone of the `prompt.state` object is emitted for each keypress.
`alert`	Emitted when `prompt.alert()` is called. This is useful for detecting invalid keypresses when output is not visible in the terminal (as in unit tests).
`submit`	Emitted with the answer `value` when submitted by the user.
`cancel`	Emitted when the prompt is terminated by the user or an error is thrown.
`close`	Emitted when the readline interface is closed and the input stream is paused.
`run`	Emitted when the prompt has been initialized.