Skip to content

refactor(cli): show key hints for multichoice promtps #1392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fengmk2 merged 5 commits into from
Apr 16, 2026
Merged

refactor(cli): show key hints for multichoice promtps #1392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
37fa7ae
Show multichoice hint for keys
rChaoz Apr 15, 2026
2e53909
Format
rChaoz Apr 15, 2026
5365e20
Update test snapshot
rChaoz Apr 15, 2026
a7115be
Merge branch 'main' into fix/multichoice-hint
fengmk2 Apr 16, 2026
f0dc6e2
Merge branch 'main' into fix/multichoice-hint
fengmk2 Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/prompts/src/__tests__/__snapshots__/render.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ exports[`prompt renderers > renders multiselect with cursor marker plus checkbox
Second line
› ◼ Beta
◻ Gamma
Press space to select, enter to submit

"
`;
Expand Down
21 changes: 12 additions & 9 deletions packages/prompts/src/multi-select.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,15 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
);
};
const required = opts.required ?? true;
const hint =
' ' +
color.reset(
color.dim(
`Press ${color.gray(color.bgWhite(color.inverse(' space ')))} to select, ${color.gray(
color.bgWhite(color.inverse(' enter ')),
)} to submit`,
),
);

return new MultiSelectPrompt({
options: opts.options,
Expand All @@ -131,13 +140,7 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
cursorAt: opts.cursorAt,
validate(selected: Value[] | undefined) {
if (required && (selected === undefined || selected.length === 0)) {
return `Please select at least one option.\n${color.reset(
color.dim(
`Press ${color.gray(color.bgWhite(color.inverse(' space ')))} to select, ${color.gray(
color.bgWhite(color.inverse(' enter ')),
)} to submit`,
),
)}`;
return `Please select at least one option.\n${hint}`;
}
return undefined;
},
Expand Down Expand Up @@ -221,7 +224,7 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
columnPadding: prefix.length,
rowPadding: titleLineCount + footerLineCount,
style: styleOption,
}).join(`\n${prefix}`)}\n${footer}\n`;
}).join(`\n${prefix}`)}\n${hint}\n${footer}\n`;
}
default: {
const prefix = hasGuide ? `${color.blue(S_BAR)} ` : nestedPrefix;
Expand All @@ -236,7 +239,7 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
columnPadding: prefix.length,
rowPadding: titleLineCount + footerLineCount,
style: styleOption,
}).join(`\n${prefix}`)}\n${hasGuide ? color.blue(S_BAR_END) : ''}\n`;
}).join(`\n${prefix}`)}\n${hint}\n${hasGuide ? color.blue(S_BAR_END) : ''}\n`;
}
}
},
Expand Down
Loading