Back to Enquirer

Key Bindings

docs/key-bindings.md

2.4.06.7 KB
Original Source

Key Bindings

All prompts

These key combinations may be used with all prompts.

commanddescription
<kbd>ctrl</kbd> + <kbd>c</kbd>Cancel the prompt.
<kbd>ctrl</kbd> + <kbd>g</kbd>Reset the prompt to its initial state.

Move cursor

These combinations may be used on prompts that support user input (eg. input prompt, password prompt, and invisible prompt).

commanddescription
<kbd>left</kbd>Move the cursor back one character.
<kbd>right</kbd>Move the cursor forward one character.
<kbd>ctrl</kbd> + <kbd>a</kbd>Move cursor to the start of the line
<kbd>ctrl</kbd> + <kbd>e</kbd>Move cursor to the end of the line
<kbd>ctrl</kbd> + <kbd>b</kbd>Move cursor back one character
<kbd>ctrl</kbd> + <kbd>f</kbd>Move cursor forward one character
<kbd>ctrl</kbd> + <kbd>x</kbd>Toggle between first and cursor position

Edit Input

These key combinations may be used on prompts that support user input (eg. input prompt, password prompt, and invisible prompt).

commanddescription
<kbd>ctrl</kbd> + <kbd>a</kbd>Move cursor to the start of the line
<kbd>ctrl</kbd> + <kbd>e</kbd>Move cursor to the end of the line
<kbd>ctrl</kbd> + <kbd>b</kbd>Move cursor back one character
<kbd>ctrl</kbd> + <kbd>f</kbd>Move cursor forward one character
<kbd>ctrl</kbd> + <kbd>x</kbd>Toggle between first and cursor position
command (Mac)command (Windows)description
<kbd>delete</kbd><kbd>backspace</kbd>Delete one character to the left.
<kbd>fn</kbd> + <kbd>delete</kbd><kbd>delete</kbd>Delete one character to the right.
<kbd>option</kbd> + <kbd>up</kbd><kbd>alt</kbd> + <kbd>up</kbd>Scroll to the previous item in history (Input prompt only, when history is enabled).
<kbd>option</kbd> + <kbd>down</kbd><kbd>alt</kbd> + <kbd>down</kbd>Scroll to the next item in history (Input prompt only, when history is enabled).

Select choices

These key combinations may be used on prompts that support multiple choices, such as the multiselect prompt, or the select prompt when the multiple options is true.

commanddescription
<kbd>space</kbd>Toggle the currently selected choice when options.multiple is true.
<kbd>number</kbd>Move the pointer to the choice at the given index. Also toggles the selected choice when options.multiple is true.
<kbd>a</kbd>Toggle all choices to be enabled or disabled.
<kbd>i</kbd>Invert the current selection of choices.
<kbd>g</kbd>Toggle the current choice group.

Hide/show choices

commanddescription
<kbd>fn</kbd> + <kbd>up</kbd>Decrease the number of visible choices by one.
<kbd>fn</kbd> + <kbd>down</kbd>Increase the number of visible choices by one.

Move/lock Pointer

commanddescription
<kbd>number</kbd>Move the pointer to the choice at the given index. Also toggles the selected choice when options.multiple is true.
<kbd>up</kbd>Move the pointer up.
<kbd>down</kbd>Move the pointer down.
<kbd>ctrl</kbd> + <kbd>a</kbd>Move the pointer to the first visible choice.
<kbd>ctrl</kbd> + <kbd>e</kbd>Move the pointer to the last visible choice.
<kbd>shift</kbd> + <kbd>up</kbd>Scroll up one choice without changing pointer position (locks the pointer while scrolling).
<kbd>shift</kbd> + <kbd>down</kbd>Scroll down one choice without changing pointer position (locks the pointer while scrolling).
command (Mac)command (Windows)description
<kbd>fn</kbd> + <kbd>left</kbd><kbd>home</kbd>Move the pointer to the first choice in the choices array.
<kbd>fn</kbd> + <kbd>right</kbd><kbd>end</kbd>Move the pointer to the last choice in the choices array.