Feat/checkbox disabled (#1205)

* feat(checkbox): customizable text for disabled text

* docs(checkbox): update usage description

packages/checkbox/README.md

@@ -23,6 +23,11 @@ const answer = await checkbox({
     { name: 'npm', value: 'npm' },
     { name: 'yarn', value: 'yarn' },
     { name: 'pnpm', value: 'pnpm', disabled: true },
+    {
+      name: 'pnpm',
+      value: 'pnpm',
+      disabled: '(pnpm is not available)',
+    },
   ],
 });
 ```
@@ -32,7 +37,7 @@ const answer = await checkbox({
 | Property | Type      | Required | Description                    |
 | -------- | --------- | -------- | ------------------------------ |
 | message  | `string`  | yes      | The question to ask            |
-| choices  | `Array<{ value: string, name?: string, disabled?: boolean }>` | 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. |
+| choices  | `Array<{ value: string, name?: string, disabled?: boolean \| string }>` | 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. |
 
 # License
 

packages/checkbox/demo.mts

@@ -9,6 +9,11 @@ import checkbox from './src/index.mjs';
       { name: 'npm', value: 'npm' },
       { name: 'yarn', value: 'yarn' },
       { name: 'jspm', value: 'jspm', disabled: true },
+      {
+        name: 'pnpm',
+        value: 'pnpm',
+        disabled: '(pnpm is not available)',
+      },
     ],
   });
   console.log('Answer:', answer);

packages/checkbox/src/index.mts

@@ -19,7 +19,7 @@ import ansiEscapes from 'ansi-escapes';
 export type Choice<Value> = {
   name?: string;
   value: Value;
-  disabled?: boolean;
+  disabled?: boolean | string;
 };
 
 type Config<Value> = {
@@ -131,7 +131,9 @@ export default createPrompt(
       .map(({ name, value, checked, disabled }, index) => {
         const line = name || value;
         if (disabled) {
-          return chalk.dim(` - ${line} (disabled)`);
+          return chalk.dim(
+            `- ${line} ${typeof disabled === 'string' ? disabled : '(disabled)'}`
+          );
         }
 
         const checkbox = checked ? chalk.green(figures.circleFilled) : figures.circle;