Interface GroupMultiSelectOptions

packages/prompts/src/group-multi-select.ts:20–69

 * Options for the {@link groupMultiselect} prompt.
 */
export interface GroupMultiSelectOptions<Value> extends CommonOptions {
	/**
	 * The message or question shown to the user above the input.
	 */
	message: string;

	/**
	 * Grouped options to display. Each key is a group label, and each value is an array of options.
	 */
	options: Record<string, Option<Value>[]>;

	/**
	 * The initially selected option(s).
	 */
	initialValues?: Value[];

	/**
	 * The maximum number of items/options to display at once.
	 */
	maxItems?: number;

	/**
	 * When `true` at least one option must be selected.
	 * @default true
	 */
	required?: boolean;

	/**
	 * The value the cursor should be positioned at initially.
	 */
	cursorAt?: Value;

	/**
	 * Whether entire groups can be selected at once.
	 * @default true
	 */
	selectableGroups?: boolean;

	/**
	 * Number of blank lines between groups.
	 * @default 0
	 */
	groupSpacing?: number;

	/**
	 * Show keyboard instructions below the option list.
	 * @default true
	 */
	showInstructions?: boolean;
}

/**
 * The `groupMultiselect` prompt extends the {@link multiselect} prompt to allow