@inquirer/select 4.1.1 → 4.2.0

package/README.md

@@ -95,14 +95,15 @@ const answer = await select({
 
 ## Options
 
-| Property | Type                    | Required | Description                                                                                                                                 |
-| -------- | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| message  | `string`                | yes      | The question to ask                                                                                                                         |
-| choices  | `Choice[]`              | yes      | List of the available choices.                                                                                                              |
-| default  | `string`                | no       | Defines in front of which item the cursor will initially appear. When omitted, the cursor will appear on the first selectable item.         |
-| pageSize | `number`                | no       | By default, lists of choice longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once. |
-| loop     | `boolean`               | no       | Defaults to `true`. When set to `false`, the cursor will be constrained to the top and bottom of the choice list without looping.           |
-| theme    | [See Theming](#Theming) | no       | Customize look of the prompt.                                                                                                               |
+| Property     | Type                                     | Required | Description                                                                                                                                 |
+| ------------ | ---------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| message      | `string`                                 | yes      | The question to ask                                                                                                                         |
+| choices      | `Choice[]`                               | yes      | List of the available choices.                                                                                                              |
+| default      | `string`                                 | no       | Defines in front of which item the cursor will initially appear. When omitted, the cursor will appear on the first selectable item.         |
+| pageSize     | `number`                                 | no       | By default, lists of choice longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once. |
+| loop         | `boolean`                                | no       | Defaults to `true`. When set to `false`, the cursor will be constrained to the top and bottom of the choice list without looping.           |
+| instructions | `{ navigation: string; pager: string; }` | no       | Defines the help tip content.                                                                                                               |
+| theme        | [See Theming](#Theming)                  | no       | Customize look of the prompt.                                                                                                               |
 
 `Separator` objects can be used in the `choices` array to render non-selectable lines in the choice list. By default it'll render a line, but you can provide the text as argument (`new Separator('-- Dependencies --')`). This option is often used to add labels to groups within long list of options.
 

package/dist/commonjs/index.d.ts

@@ -25,6 +25,10 @@ declare const _default: <Value>(config: {
     pageSize?: number | undefined;
     loop?: boolean | undefined;
     default?: unknown;
+    instructions?: {
+        navigation: string;
+        pager: string;
+    } | undefined;
     theme?: PartialDeep<Theme<SelectTheme>> | undefined;
 }, context?: import("@inquirer/type").Context) => Promise<Value> & {
     cancel: () => void;

package/dist/commonjs/index.js

@@ -127,10 +127,10 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
         (theme.helpMode === 'auto' && firstRender.current)) {
         firstRender.current = false;
         if (items.length > pageSize) {
-            helpTipBottom = `\n${theme.style.help('(Use arrow keys to reveal more choices)')}`;
+            helpTipBottom = `\n${theme.style.help(`(${config.instructions?.pager ?? 'Use arrow keys to reveal more choices'})`)}`;
         }
         else {
-            helpTipTop = theme.style.help('(Use arrow keys)');
+            helpTipTop = theme.style.help(`(${config.instructions?.navigation ?? 'Use arrow keys'})`);
         }
     }
     const page = (0, core_1.usePagination)({

package/dist/esm/index.d.ts

@@ -25,6 +25,10 @@ declare const _default: <Value>(config: {
     pageSize?: number | undefined;
     loop?: boolean | undefined;
     default?: unknown;
+    instructions?: {
+        navigation: string;
+        pager: string;
+    } | undefined;
     theme?: PartialDeep<Theme<SelectTheme>> | undefined;
 }, context?: import("@inquirer/type").Context) => Promise<Value> & {
     cancel: () => void;

package/dist/esm/index.js

@@ -121,10 +121,10 @@ export default createPrompt((config, done) => {
         (theme.helpMode === 'auto' && firstRender.current)) {
         firstRender.current = false;
         if (items.length > pageSize) {
-            helpTipBottom = `\n${theme.style.help('(Use arrow keys to reveal more choices)')}`;
+            helpTipBottom = `\n${theme.style.help(`(${config.instructions?.pager ?? 'Use arrow keys to reveal more choices'})`)}`;
         }
         else {
-            helpTipTop = theme.style.help('(Use arrow keys)');
+            helpTipTop = theme.style.help(`(${config.instructions?.navigation ?? 'Use arrow keys'})`);
         }
     }
     const page = usePagination({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/select",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Inquirer select/list prompt",
   "keywords": [
     "answer",
@@ -109,5 +109,5 @@
       "optional": true
     }
   },
-  "gitHead": "d367155a8d64d8b3e93f9c763adccf708aedc8a8"
+  "gitHead": "238c3af2ecf5fefb9b010fda99bb3a532fa4f61a"
 }