Feat: Expose customization options for Select/Checkbox prompts help t…

…ips (#1381) * Chore: Add type tests to @inquirer/prompts * Feat: Expose customization options for Select/Checkbox prompts help tips Fix #963 Fix #1217
SBoudrias · Apr 12, 2024 · 196f954 · 196f954
1 parent fedcd16
commit 196f954
Show file tree

Hide file tree

Showing 12 changed files with 459 additions and 114 deletions.
diff --git a/packages/checkbox/README.md b/packages/checkbox/README.md
@@ -77,9 +77,16 @@ type Theme = {
     unchecked: string;
     cursor: string;
   };
+  helpMode: 'always' | 'never' | 'auto';
 };
 ```
 
+### `theme.helpMode`
+
+- `auto` (default): Hide the help tips after an interaction occurs. The scroll tip will hide after any interactions, the selection tip will hide as soon as a first selection is done.
+- `always`: The help tips will always show and never hide.
+- `never`: The help tips will never show.
+
 # License
 
 Copyright (c) 2023 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))<br/>