An open source design system that's fully customizable and agent ready
TypeScript
refactor(MultiSelector): rename formatTriggerCount to formatValue and widen it to the trigger line (#5377)
Cindy Zhangd895769c5ae0
diff --git a/.changeset/multiselector-format-value.md b/.changeset/multiselector-format-value.mdnew file mode 100644index 0000000000..c120a074f1--- /dev/null+++ b/.changeset/multiselector-format-value.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[component] MultiSelector: rename the unreleased `formatTriggerCount` prop to `formatValue` and widen it to the whole trigger line. It now receives the selected items (`{value, label}[]`, count available as `.length`) and formats the trigger for `triggerDisplay="count"` and `"labels"`; `"badges"` renders elements, so it is not used there. `formatValue` matches NumberInput and Slider, so the same idea has one name across the system. Defaults are unchanged when the prop is absent.++@Kevinjohndiff --git a/apps/storybook/stories/Chat.stories.tsx b/apps/storybook/stories/Chat.stories.tsxindex b0b608ee50..dd9012c50f 100644--- a/apps/storybook/stories/Chat.stories.tsx+++ b/apps/storybook/stories/Chat.stories.tsx@@ -629,7 +629,7 @@ export const Alignment: StoryObj = {</ChatMessage><ChatMessagesender="assistant"- avatar={<Avatar name="Navi" size="small" />}>+ avatar={<Avatar name="Navi" size="sm" />}><ChatMessageBubble>{align === 'top'? 'Top alignment keeps messages at the top — good for logs and document-style lists.'diff --git a/packages/core/src/MultiSelector/MultiSelector.doc.mjs b/packages/core/src/MultiSelector/MultiSelector.doc.mjsindex b0f5cee349..aa53eb87d4 100644--- a/packages/core/src/MultiSelector/MultiSelector.doc.mjs+++ b/packages/core/src/MultiSelector/MultiSelector.doc.mjs@@ -104,10 +104,10 @@ export const docs = {default: "'count'",},{- name: 'formatTriggerCount',- type: '(count: number) => string',+ name: 'formatValue',+ type: '(items: {value: string; label: string}[]) => string',description:- 'Formats the trigger text when triggerDisplay="count". Receives the selected count and returns the full trigger text.',+ 'Formats the trigger text when triggerDisplay="count" or "labels". Receives the selected items (value plus resolved label); the count is items.length. Not used by triggerDisplay="badges".',},{name: 'maxBadges',@@ -290,6 +290,8 @@ export const docsZh = {placeholder: '未选择值时显示的占位文本。',size: '选择器的尺寸变体。',triggerDisplay: '在触发器中显示选中项的方式。',+ formatValue:+ '格式化 triggerDisplay="count" 或 "labels" 时的触发器文本。接收选中项(value 及解析后的 label),数量为 items.length。triggerDisplay="badges" 不使用此属性。',maxBadges:'显示"+N"之前的最大徽章数。仅适用于 triggerDisplay="badges"。',hasSelectAll: '是否显示全选复选框。',@@ -426,8 +428,8 @@ export const docsDense = {variant:'visual trigger style: input bordered control or ghost toolbar control',triggerDisplay: 'how to show selected in trigger',- formatTriggerCount:- 'formats count-mode trigger text; receives selected count',+ formatValue:+ 'formats count/labels trigger text; receives selected items',maxBadges: 'max badges before "+N"; badges mode only',hasSelectAll: 'show select-all checkbox',selectAllLabel: 'select-all label',diff --git a/packages/core/src/MultiSelector/MultiSelector.test.tsx b/packages/core/src/MultiSelector/MultiSelector.test.tsxindex 07b87c7ae2..17c3e049db 100644--- a/packages/core/src/MultiSelector/MultiSelector.test.tsx+++ b/packages/core/src/MultiSelector/MultiSelector.test.tsx@@ -128,19 +128,90 @@ describe('MultiSelector', () => {expect(screen.getByText('2 selected')).toBeInTheDocument();});- it('formats the count display with formatTriggerCount', () => {+ it('formats the count display with formatValue', () => {render(<MultiSelectorlabel="Spaces"options={defaultOptions}value={['Apple', 'Banana']}onChange={() => {}}- formatTriggerCount={count => `${count} spaces selected`}+ formatValue={items => `${items.length} spaces selected`}/>,);expect(screen.getByText('2 spaces selected')).toBeInTheDocument();});+ it('passes selected values and resolved labels to formatValue', () => {+ const formatValue = vi.fn(+ (items: {value: string; label: string}[]) =>+ `${items[0].label} and ${items.length - 1} more`,+ );+ render(+ <MultiSelector+ label="Fruit"+ options={[+ {value: 'a', label: 'Apple'},+ {value: 'b', label: 'Banana'},+ ]}+ value={['a', 'b']}+ onChange={() => {}}+ formatValue={formatValue}+ />,+ );+ expect(formatValue).toHaveBeenCalledWith([+ {value: 'a', label: 'Apple'},+ {value: 'b', label: 'Banana'},+ ]);+ expect(screen.getByText('Apple and 1 more')).toBeInTheDocument();+ });++ it('formats the labels display with formatValue', () => {+ render(+ <MultiSelector+ label="Fruit"+ options={defaultOptions}+ value={['Apple', 'Banana', 'Orange']}+ onChange={() => {}}+ triggerDisplay="labels"+ formatValue={items => items.map(item => item.label).join(' & ')}+ />,+ );+ expect(screen.getByText('Apple & Banana & Orange')).toBeInTheDocument();+ });++ it('ignores formatValue in badges display', () => {+ render(+ <MultiSelector+ label="Fruit"+ options={defaultOptions}+ value={['Apple', 'Banana']}+ onChange={() => {}}+ triggerDisplay="badges"+ formatValue={() => 'formatted'}+ />,+ );+ expect(screen.queryByText('formatted')).not.toBeInTheDocument();+ const trigger = within(screen.getByRole('combobox'));+ expect(trigger.getByText('Apple')).toBeInTheDocument();+ expect(trigger.getByText('Banana')).toBeInTheDocument();+ });++ it('shows the placeholder rather than calling formatValue when empty', () => {+ const formatValue = vi.fn(() => 'formatted');+ render(+ <MultiSelector+ label="Fruit"+ options={defaultOptions}+ value={[]}+ onChange={() => {}}+ placeholder="Pick fruits..."+ formatValue={formatValue}+ />,+ );+ expect(screen.getByText('Pick fruits...')).toBeInTheDocument();+ expect(formatValue).not.toHaveBeenCalled();+ });+it('shows labels display', () => {render(<MultiSelectordiff --git a/packages/core/src/MultiSelector/MultiSelector.tsx b/packages/core/src/MultiSelector/MultiSelector.tsxindex fc9ad72b93..403a929bc3 100644--- a/packages/core/src/MultiSelector/MultiSelector.tsx+++ b/packages/core/src/MultiSelector/MultiSelector.tsx@@ -424,6 +424,11 @@ export type MultiSelectorStatusType = 'warning' | 'error' | 'success';export type {MultiSelectorStatus};+export interface MultiSelectorSelectedItem {+ value: string;+ label: string;+}+export interface MultiSelectorProps<T extends MultiSelectorOptionType = MultiSelectorOptionType,> extends Omit<BaseProps, 'onChange' | 'defaultValue'> {@@ -609,11 +614,15 @@ export interface MultiSelectorProps<triggerDisplay?: 'count' | 'labels' | 'badges';/**- * Formats the trigger text when triggerDisplay is 'count'.- * Receives the number of selected values and returns the full trigger text.- * @default count => `${count} selected`+ * Formats the trigger text when triggerDisplay is 'count' or 'labels'.+ * Receives the selected items (value plus resolved label, in selection+ * order) and returns the full trigger text; the count is `items.length`.+ * Not called when nothing is selected — the placeholder shows instead — and+ * not called for triggerDisplay 'badges', which renders Badge elements+ * rather than text.+ * @default items => `${items.length} selected` for 'count', "A, B, C, +N" for 'labels'*/- formatTriggerCount?: (count: number) => string;+ formatValue?: (items: MultiSelectorSelectedItem[]) => string;/*** Maximum number of badges to show before showing "+N".@@ -718,7 +727,7 @@ export function MultiSelector<T extends MultiSelectorOptionType>({hasSearch = false,searchPlaceholder: searchPlaceholderFromProps,triggerDisplay = 'count',- formatTriggerCount,+ formatValue,maxBadges = 3,renderOption,indicatorPosition = 'start',@@ -1115,13 +1124,18 @@ export function MultiSelector<T extends MultiSelectorOptionType>({}, [popover.isOpen, highlightedIndex, getItemId]);// Build trigger display content- const selectedLabels = useMemo(() => {+ const selectedItems = useMemo(() => {return optimisticValue.map(v => {const item = selectableItems.find(i => i.value === v);- return item?.label ?? v;+ return {value: v, label: item?.label ?? v};});}, [optimisticValue, selectableItems]);+ const selectedLabels = useMemo(+ () => selectedItems.map(item => item.label),+ [selectedItems],+ );+const renderTriggerContent = useCallback(() => {if (optimisticValue.length === 0) {return <span {...stylex.props(styles.triggerText)}>{placeholder}</span>;@@ -1131,7 +1145,7 @@ export function MultiSelector<T extends MultiSelectorOptionType>({case 'count':return (<span {...stylex.props(styles.triggerText)}>- {formatTriggerCount?.(optimisticValue.length) ??+ {formatValue?.(selectedItems) ??`${optimisticValue.length} selected`}</span>);@@ -1143,7 +1157,11 @@ export function MultiSelector<T extends MultiSelectorOptionType>({remaining > 0? `${displayed.join(', ')}, +${remaining}`: displayed.join(', ');- return <span {...stylex.props(styles.triggerText)}>{text}</span>;+ return (+ <span {...stylex.props(styles.triggerText)}>+ {formatValue?.(selectedItems) ?? text}+ </span>+ );}case 'badges': {@@ -1166,9 +1184,10 @@ export function MultiSelector<T extends MultiSelectorOptionType>({}, [optimisticValue,triggerDisplay,+ selectedItems,selectedLabels,placeholder,- formatTriggerCount,+ formatValue,maxBadges,]);diff --git a/packages/core/src/MultiSelector/index.ts b/packages/core/src/MultiSelector/index.tsindex d1a6fb7b09..6f48bb5359 100644--- a/packages/core/src/MultiSelector/index.ts+++ b/packages/core/src/MultiSelector/index.ts@@ -13,6 +13,7 @@ export {type MultiSelectorProps,type MultiSelectorSize,type MultiSelectorStatusType,+ type MultiSelectorSelectedItem,} from './MultiSelector';export type {MultiSelectorOptionType,