@inquirer/checkbox
Advanced tools
@inquirer/checkbox - npm Package Compare versions
Comparing version 2.3.11 to 2.4.0
@@ -28,3 +28,5 @@ "use strict"; | ||
| disabledChoice: (text) => yoctocolors_cjs_1.default.dim(`- ${text}`), | ||
| renderSelectedChoices: (selectedChoices) => selectedChoices.map((choice) => choice.name || choice.value).join(', '), | ||
| renderSelectedChoices: (selectedChoices) => selectedChoices | ||
| .map((choice) => { var _a, _b; return (_b = (_a = choice.short) !== null && _a !== void 0 ? _a : choice.name) !== null && _b !== void 0 ? _b : choice.value; }) | ||
| .join(', '), | ||
| }, | ||
@@ -31,0 +33,0 @@ helpMode: 'auto', |
@@ -18,2 +18,3 @@ import { Separator, type Theme } from '@inquirer/core'; | ||
| value: Value; | ||
| short?: string; | ||
| disabled?: boolean | string; | ||
@@ -20,0 +21,0 @@ checked?: boolean; |
| { | ||
| "name": "@inquirer/checkbox", | ||
| "version": "2.3.11", | ||
| "version": "2.4.0", | ||
| "engines": { | ||
@@ -92,3 +92,3 @@ "node": ">=18" | ||
| "sideEffects": false, | ||
| "gitHead": "eb7a658ca58d8cc5863efb9289ae1b42e818bdd0" | ||
| "gitHead": "6e2ddec8ca97ee176f080efd2cba76e39b5b9628" | ||
| } |
@@ -55,11 +55,11 @@ # `@inquirer/checkbox` | ||
| | Property | Type | Required | Description | | ||
| | -------- | ------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | message | `string` | yes | The question to ask | | ||
| | choices | `Array<{ value: string, name?: string, disabled?: boolean \| string, checked?: boolean } \| Separator>` | yes | List of the available choices. The `value` will be returned as the answer, and used as display if no `name` is defined. Choices who're `disabled` will be displayed, but not selectable. | | ||
| | 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. | | ||
| | required | `boolean` | no | When set to `true`, ensures at least one choice must be selected. | | ||
| | validate | `string\[\] => boolean \| string \| Promise<boolean \| string>` | no | On submit, validate the choices. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. | | ||
| | theme | [See Theming](#Theming) | no | Customize look of the prompt. | | ||
| | Property | Type | Required | Description | | ||
| | -------- | ----------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | message | `string` | yes | The question to ask | | ||
| | choices | `Array<{ value: string, name?: string, short?: string, disabled?: boolean \| string, checked?: boolean } \| Separator>` | yes | List of the available choices. The `value` will be returned as the answer, and used as display if no `name` is defined. Choices who're `disabled` will be displayed, but not selectable. `short` if defined will be used instead of `name` once submitted. | | ||
| | 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. | | ||
| | required | `boolean` | no | When set to `true`, ensures at least one choice must be selected. | | ||
| | validate | `string\[\] => boolean \| string \| Promise<boolean \| string>` | no | On submit, validate the choices. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. | | ||
| | theme | [See Theming](#Theming) | no | Customize look of the prompt. | | ||
@@ -66,0 +66,0 @@ The `Separator` object can be used 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. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by3.19%
27196
- Lines of code
- increased by1.26%
401