Skip to content

fix: wrapping in multi-selects #411

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
merged 1 commit into from
Nov 9, 2025
Merged

fix: wrapping in multi-selects #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/fine-swans-retire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": patch
---

Add support for wrapped messages in multi line prompts
47 changes: 34 additions & 13 deletions packages/prompts/src/multi-select.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { MultiSelectPrompt } from '@clack/core';
import { MultiSelectPrompt, wrapTextWithPrefix } from '@clack/core';
import color from 'picocolors';
import {
type CommonOptions,
Expand All @@ -8,6 +8,7 @@ import {
S_CHECKBOX_INACTIVE,
S_CHECKBOX_SELECTED,
symbol,
symbolBar,
} from './common.js';
import { limitOptions } from './limit-options.js';
import type { Option } from './select.js';
Expand All @@ -20,6 +21,13 @@ export interface MultiSelectOptions<Value> extends CommonOptions {
required?: boolean;
cursorAt?: Value;
}
const computeLabel = (label: string, format: (text: string) => string) => {
return label
.split('\n')
.map((line) => format(line))
.join('\n');
};

export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
const opt = (
option: Option<Value>,
Expand All @@ -34,7 +42,7 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
) => {
const label = option.label ?? String(option.value);
if (state === 'disabled') {
return `${color.gray(S_CHECKBOX_INACTIVE)} ${color.gray(label)}${
return `${color.gray(S_CHECKBOX_INACTIVE)} ${computeLabel(label, color.gray)}${
option.hint ? ` ${color.dim(`(${option.hint ?? 'disabled'})`)}` : ''
}`;
}
Expand All @@ -44,22 +52,22 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
}`;
}
if (state === 'selected') {
return `${color.green(S_CHECKBOX_SELECTED)} ${color.dim(label)}${
return `${color.green(S_CHECKBOX_SELECTED)} ${computeLabel(label, color.dim)}${
option.hint ? ` ${color.dim(`(${option.hint})`)}` : ''
}`;
}
if (state === 'cancelled') {
return `${color.strikethrough(color.dim(label))}`;
return `${computeLabel(label, (text) => color.strikethrough(color.dim(text)))}`;
}
if (state === 'active-selected') {
return `${color.green(S_CHECKBOX_SELECTED)} ${label}${
option.hint ? ` ${color.dim(`(${option.hint})`)}` : ''
}`;
}
if (state === 'submitted') {
return `${color.dim(label)}`;
return `${computeLabel(label, color.dim)}`;
}
return `${color.dim(S_CHECKBOX_INACTIVE)} ${color.dim(label)}`;
return `${color.dim(S_CHECKBOX_INACTIVE)} ${computeLabel(label, color.dim)}`;
};
const required = opts.required ?? true;

Expand All @@ -82,7 +90,13 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {
)}`;
},
render() {
const title = `${color.gray(S_BAR)}\n${symbol(this.state)} ${opts.message}\n`;
const wrappedMessage = wrapTextWithPrefix(
opts.output,
opts.message,
`${symbolBar(this.state)} `,
`${symbol(this.state)} `
);
const title = `${color.gray(S_BAR)}\n${wrappedMessage}\n`;
const value = this.value ?? [];

const styleOption = (option: Option<Value>, active: boolean) => {
Expand All @@ -101,21 +115,28 @@ export const multiselect = <Value>(opts: MultiSelectOptions<Value>) => {

switch (this.state) {
case 'submit': {
return `${title}${color.gray(S_BAR)} ${
const submitText =
this.options
.filter(({ value: optionValue }) => value.includes(optionValue))
.map((option) => opt(option, 'submitted'))
.join(color.dim(', ')) || color.dim('none')
}`;
.join(color.dim(', ')) || color.dim('none');
const wrappedSubmitText = wrapTextWithPrefix(
opts.output,
submitText,
`${color.gray(S_BAR)} `
);
return `${title}${wrappedSubmitText}`;
}
case 'cancel': {
const label = this.options
.filter(({ value: optionValue }) => value.includes(optionValue))
.map((option) => opt(option, 'cancelled'))
.join(color.dim(', '));
return `${title}${color.gray(S_BAR)}${
label.trim() ? ` ${label}\n${color.gray(S_BAR)}` : ''
}`;
if (label.trim() === '') {
return `${title}${color.gray(S_BAR)}`;
}
const wrappedLabel = wrapTextWithPrefix(opts.output, label, `${color.gray(S_BAR)} `);
return `${title}${wrappedLabel}\n${color.gray(S_BAR)}`;
}
case 'error': {
const prefix = `${color.yellow(S_BAR)} `;
Expand Down
196 changes: 196 additions & 0 deletions packages/prompts/test/__snapshots__/multi-select.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,104 @@ exports[`multiselect (isCI = false) > sliding window loops upwards 1`] = `
]
`;

exports[`multiselect (isCI = false) > wraps cancelled state with long options 1`] = `
[
"<cursor.hide>",
"│
◆ foo
│ ◻ Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0
│ ◻ Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1
└
",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=2>",
"<erase.line><cursor.left count=1>",
"│ ◼ Option 0 Option 0 Option ",
"<cursor.down count=9>",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=1>",
"<erase.down>",
"■ foo
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0
│",
"
",
"<cursor.show>",
]
`;

exports[`multiselect (isCI = false) > wraps long messages 1`] = `
[
"<cursor.hide>",
"│
◆ foo foo foo foo foo foo foo
│ foo foo foo foo foo foo
│ foo foo foo foo foo foo foo
│ ◻ opt0
│ ◻ opt1
└
",
"<cursor.backward count=999><cursor.up count=7>",
"<cursor.down count=4>",
"<erase.line><cursor.left count=1>",
"│ ◼ opt0",
"<cursor.down count=3>",
"<cursor.backward count=999><cursor.up count=7>",
"<cursor.down count=1>",
"<erase.down>",
"◇ foo foo foo foo foo foo foo
│ foo foo foo foo foo foo
│ foo foo foo foo foo foo foo
│ opt0",
"
",
"<cursor.show>",
]
`;

exports[`multiselect (isCI = false) > wraps success state with long options 1`] = `
[
"<cursor.hide>",
"│
◆ foo
│ ◻ Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0
│ ◻ Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1
└
",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=2>",
"<erase.line><cursor.left count=1>",
"│ ◼ Option 0 Option 0 Option ",
"<cursor.down count=9>",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=1>",
"<erase.down>",
"◇ foo
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0",
"
",
"<cursor.show>",
]
`;

exports[`multiselect (isCI = true) > can be aborted by a signal 1`] = `
[
"<cursor.hide>",
Expand Down Expand Up @@ -1271,3 +1369,101 @@ exports[`multiselect (isCI = true) > sliding window loops upwards 1`] = `
"<cursor.show>",
]
`;

exports[`multiselect (isCI = true) > wraps cancelled state with long options 1`] = `
[
"<cursor.hide>",
"│
◆ foo
│ ◻ Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0
│ ◻ Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1
└
",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=2>",
"<erase.line><cursor.left count=1>",
"│ ◼ Option 0 Option 0 Option ",
"<cursor.down count=9>",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=1>",
"<erase.down>",
"■ foo
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0
│",
"
",
"<cursor.show>",
]
`;

exports[`multiselect (isCI = true) > wraps long messages 1`] = `
[
"<cursor.hide>",
"│
◆ foo foo foo foo foo foo foo
│ foo foo foo foo foo foo
│ foo foo foo foo foo foo foo
│ ◻ opt0
│ ◻ opt1
└
",
"<cursor.backward count=999><cursor.up count=7>",
"<cursor.down count=4>",
"<erase.line><cursor.left count=1>",
"│ ◼ opt0",
"<cursor.down count=3>",
"<cursor.backward count=999><cursor.up count=7>",
"<cursor.down count=1>",
"<erase.down>",
"◇ foo foo foo foo foo foo foo
│ foo foo foo foo foo foo
│ foo foo foo foo foo foo foo
│ opt0",
"
",
"<cursor.show>",
]
`;

exports[`multiselect (isCI = true) > wraps success state with long options 1`] = `
[
"<cursor.hide>",
"│
◆ foo
│ ◻ Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0 Option 0 Option
│ 0 Option 0
│ ◻ Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1 Option 1 Option 
│ 1 Option 1
└
",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=2>",
"<erase.line><cursor.left count=1>",
"│ ◼ Option 0 Option 0 Option ",
"<cursor.down count=9>",
"<cursor.backward count=999><cursor.up count=11>",
"<cursor.down count=1>",
"<erase.down>",
"◇ foo
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0 Option 0 Option 0 
│ Option 0",
"
",
"<cursor.show>",
]
`;
63 changes: 63 additions & 0 deletions packages/prompts/test/multi-select.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,4 +336,67 @@ describe.each(['true', 'false'])('multiselect (isCI = %s)', (isCI) => {
expect(value).toEqual(['opt1']);
expect(output.buffer).toMatchSnapshot();
});

test('wraps long messages', async () => {
output.columns = 40;

const result = prompts.multiselect({
message: 'foo '.repeat(20).trim(),
options: [{ value: 'opt0' }, { value: 'opt1' }],
input,
output,
});

input.emit('keypress', '', { name: 'space' });
input.emit('keypress', '', { name: 'return' });

const value = await result;

expect(value).toEqual(['opt0']);
expect(output.buffer).toMatchSnapshot();
});

test('wraps cancelled state with long options', async () => {
output.columns = 40;

const result = prompts.multiselect({
message: 'foo',
options: [
{ value: 'opt0', label: 'Option 0 '.repeat(10).trim() },
{ value: 'opt1', label: 'Option 1 '.repeat(10).trim() },
],
input,
output,
});

input.emit('keypress', '', { name: 'space' });
input.emit('keypress', 'escape', { name: 'escape' });

const value = await result;

expect(prompts.isCancel(value)).toBe(true);
expect(output.buffer).toMatchSnapshot();
});

test('wraps success state with long options', async () => {
output.columns = 40;

const result = prompts.multiselect({
message: 'foo',
options: [
{ value: 'opt0', label: 'Option 0 '.repeat(10).trim() },
{ value: 'opt1', label: 'Option 1 '.repeat(10).trim() },
],
input,
output,
});

input.emit('keypress', '', { name: 'space' });
input.emit('keypress', '', { name: 'return' });

const value = await result;

expect(value).toEqual(['opt0']);
expect(output.buffer).toMatchSnapshot();
});
});
Loading