An open source design system that's fully customizable and agent ready
TypeScript
fix(core): bound PowerSearch field browsing at 1,000 (#5233)
nynexman4464598700a96113
diff --git a/.changeset/powersearch-shows-the-full-field-list-while-brow-5j66.md b/.changeset/powersearch-shows-the-full-field-list-while-brow-5j66.mdnew file mode 100644index 0000000000..f83eb3aa31--- /dev/null+++ b/.changeset/powersearch-shows-the-full-field-list-while-brow-5j66.md@@ -0,0 +1,6 @@+---+'@astryxdesign/core': patch+---++[fix] PowerSearch now shows up to 1,000 configured fields when the search box is empty, instead of stopping at 10. Typed searches still show 10 ranked results by default; use `maxSearchResults` to change only that limit. (#5233)+@nynexman4464diff --git a/packages/core/src/PowerSearch/PowerSearch.doc.mjs b/packages/core/src/PowerSearch/PowerSearch.doc.mjsindex c9d646e7d4..c320833286 100644--- a/packages/core/src/PowerSearch/PowerSearch.doc.mjs+++ b/packages/core/src/PowerSearch/PowerSearch.doc.mjs@@ -6,7 +6,17 @@ export const docs = {name: 'PowerSearch',displayName: 'Power Search',category: 'Data Input',- keywords: ["powersearch","search","searchbar","filter","filterbar","faceted","querybuilder","structured","omnibar"],+ keywords: [+ 'powersearch',+ 'search',+ 'searchbar',+ 'filter',+ 'filterbar',+ 'faceted',+ 'querybuilder',+ 'structured',+ 'omnibar',+ ],props: [{name: 'config',@@ -43,8 +53,7 @@ export const docs = {{name: 'placeholder',type: 'string',- description:- 'Placeholder text shown when no filters are selected.',+ description: 'Placeholder text shown when no filters are selected.',default: "'Search...'",},{@@ -80,8 +89,7 @@ export const docs = {{name: 'status',type: "{type: 'warning' | 'error' | 'success', message?: string}",- description:- 'Validation status object with type and optional message.',+ description: 'Validation status object with type and optional message.',},{name: 'startIcon',@@ -110,6 +118,13 @@ export const docs = {'Maximum suggestions shown in string and entity value typeaheads. Does not affect the main field search menu or enum value menus.',default: '10',},+ {+ name: 'maxSearchResults',+ type: 'number',+ description:+ 'Max ranked results for a non-empty query. Does not affect a field value editor. Browsing with an empty query shows up to 1,000 fields.',+ default: '10',+ },{name: 'popoverSaveButtonLabel',type: 'string',@@ -186,16 +201,30 @@ export const docs = {description:'PowerSearch is a structured filter bar where each token represents a field, operator, and value. Use it for complex multi-dimensional filtering when users need to combine multiple search criteria. For simple single-field search, use a text input instead.',bestPractices: [- { guidance: true, description: 'Define clear, descriptive field names and aliases so users can quickly find the filter they need.' },- { guidance: true, description: 'Provide a result count to give users feedback on how their filters affect the data set.' },- { guidance: false, description: 'Use PowerSearch for simple keyword searches; a standard text input is more appropriate for single-field lookups.' },- { guidance: false, description: 'Wrap a disabled PowerSearch in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.' },+ {+ guidance: true,+ description:+ 'Define clear, descriptive field names and aliases so users can quickly find the filter they need.',+ },+ {+ guidance: true,+ description:+ 'Provide a result count to give users feedback on how their filters affect the data set.',+ },+ {+ guidance: false,+ description:+ 'Use PowerSearch for simple keyword searches; a standard text input is more appropriate for single-field lookups.',+ },+ {+ guidance: false,+ description:+ 'Wrap a disabled PowerSearch in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.',+ },],},theming: {- targets: [- {className: 'astryx-power-search'},- ],+ targets: [{className: 'astryx-power-search'}],},};@@ -308,6 +337,13 @@ export const docsZh = {'字符串和实体值预输入菜单中显示的最大建议数。不影响主字段搜索菜单或枚举值菜单。',default: '10',},+ {+ name: 'maxSearchResults',+ type: 'number',+ description:+ '非空查询的最大排名结果数。不影响字段值编辑器。使用空查询浏览时最多显示 1,000 个字段。',+ default: '10',+ },{name: 'popoverSaveButtonLabel',type: 'string',@@ -322,7 +358,8 @@ export const docsZh = {{name: 'handleRef',type: 'Ref<PowerSearchHandle>',- description: '提供 focusTypeahead() 和 blurTypeahead() 方法的命令式句柄。',+ description:+ '提供 focusTypeahead() 和 blurTypeahead() 方法的命令式句柄。',},{name: 'endContent',@@ -351,10 +388,26 @@ export const docsZh = {description:'PowerSearch is a structured filter bar where each token represents a field, operator, and value. Use it for complex multi-dimensional filtering when users need to combine multiple search criteria. For simple single-field search, use a text input instead.',bestPractices: [- { guidance: true, description: 'Define clear, descriptive field names and aliases so users can quickly find the filter they need.' },- { guidance: true, description: 'Provide a result count to give users feedback on how their filters affect the data set.' },- { guidance: false, description: 'Use PowerSearch for simple keyword searches; a standard text input is more appropriate for single-field lookups.' },- { guidance: false, description: 'Wrap a disabled PowerSearch in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.' },+ {+ guidance: true,+ description:+ 'Define clear, descriptive field names and aliases so users can quickly find the filter they need.',+ },+ {+ guidance: true,+ description:+ 'Provide a result count to give users feedback on how their filters affect the data set.',+ },+ {+ guidance: false,+ description:+ 'Use PowerSearch for simple keyword searches; a standard text input is more appropriate for single-field lookups.',+ },+ {+ guidance: false,+ description:+ 'Wrap a disabled PowerSearch in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.',+ },],},};@@ -367,16 +420,33 @@ export const docsDense = {description:'PowerSearch is a structured filter bar where each token represents a field, operator, and value. Use it for complex multi-dimensional filtering when users need to combine multiple search criteria. For simple single-field search, use a text input instead.',bestPractices: [- { guidance: true, description: 'Define clear, descriptive field names and aliases so users can quickly find the filter they need.' },- { guidance: true, description: 'Provide a result count to give users feedback on how their filters affect the data set.' },- { guidance: false, description: 'Use PowerSearch for simple keyword searches; a standard text input is more appropriate for single-field lookups.' },- { guidance: false, description: 'Wrap a disabled PowerSearch in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.' },+ {+ guidance: true,+ description:+ 'Define clear, descriptive field names and aliases so users can quickly find the filter they need.',+ },+ {+ guidance: true,+ description:+ 'Provide a result count to give users feedback on how their filters affect the data set.',+ },+ {+ guidance: false,+ description:+ 'Use PowerSearch for simple keyword searches; a standard text input is more appropriate for single-field lookups.',+ },+ {+ guidance: false,+ description:+ 'Wrap a disabled PowerSearch in Tooltip to explain why it is disabled; disabled controls swallow the hover events the wrapper needs. Use the disabledMessage prop instead.',+ },],},propDescriptions: {config: 'Configuration defining available fields, operators, value types.',filters: 'Currently active filters.',- onChange: "Called on filter change. changeType is 'add', 'edit', or 'remove'. index is affected filter position.",+ onChange:+ "Called on filter change. changeType is 'add', 'edit', or 'remove'. index is affected filter position.",label: 'Accessible label for search input.',isLabelHidden: 'Visually hides label while keeping accessible.',placeholder: 'Text shown when no filters selected.',@@ -385,17 +455,25 @@ export const docsDense = {isReadOnly: 'Prevent adding, editing, or removing filters.',isDisabled: 'Disables entire component.',status: 'Validation status object w/ type + optional message.',- startIcon: 'Icon at input start, before filter tokens. Forwarded to internal Tokenizer.',- statusVariant: 'How status message is placed: attached overlaps below input; detached floats below w/ spacing.',+ startIcon:+ 'Icon at input start, before filter tokens. Forwarded to internal Tokenizer.',+ statusVariant:+ 'How status message is placed: attached overlaps below input; detached floats below w/ spacing.',maxTokenLength: 'Max char length for filter value display in tokens.',maxOperatorMenuItems:'Max suggestions in string/entity value typeaheads; excludes main field search + enum menus.',+ maxSearchResults:+ 'Max ranked results for a non-empty query; excludes value editors.',popoverSaveButtonLabel: 'Label for save button in edit popover.',timezoneID: 'Timezone ID for date formatting (e.g. "America/New_York").',- handleRef: 'Imperative handle w/ focusTypeahead() + blurTypeahead() methods.',- endContent: 'Content at end of input row. Useful for action buttons or controls.',- resultCount: 'Result count matching current filters. Number formatted as "N results"; string displayed as-is.',+ handleRef:+ 'Imperative handle w/ focusTypeahead() + blurTypeahead() methods.',+ endContent:+ 'Content at end of input row. Useful for action buttons or controls.',+ resultCount:+ 'Result count matching current filters. Number formatted as "N results"; string displayed as-is.',size: 'Search input+token size.',- xstyle: 'StyleX styles for layout customization. Must be stylex.create() value.',+ xstyle:+ 'StyleX styles for layout customization. Must be stylex.create() value.',},};diff --git a/packages/core/src/PowerSearch/PowerSearch.test.tsx b/packages/core/src/PowerSearch/PowerSearch.test.tsxindex 02387aac0d..94d34abac6 100644--- a/packages/core/src/PowerSearch/PowerSearch.test.tsx+++ b/packages/core/src/PowerSearch/PowerSearch.test.tsx@@ -562,3 +562,81 @@ describe('maxOperatorMenuItems', () => {});});});++describe('field menu sizing', () => {+ const FIELD_COUNT = 25;+ const manyFields: PowerSearchConfig = {+ name: 'ManyFields',+ fields: Array.from({length: FIELD_COUNT}, (_, i) => ({+ key: `field_${i}`,+ label: `Zebra ${String(i).padStart(2, '0')}`,+ defaultOperator: 'is',+ operators: [{key: 'is', label: 'is', value: {type: 'string'} as const}],+ })),+ };++ async function openMenu(+ props?: {maxSearchResults?: number},+ config: PowerSearchConfig = manyFields,+ ) {+ const user = userEvent.setup();+ render(+ <PowerSearch+ config={config}+ filters={[]}+ onChange={() => {}}+ {...props}+ />,+ );+ await user.click(screen.getByRole('combobox'));+ await waitFor(() => {+ expect(screen.getByRole('listbox', {hidden: true})).toBeInTheDocument();+ });+ return user;+ }++ const optionCount = () =>+ screen.getAllByRole('option', {hidden: true}).length;++ it('shows every field in a normal field list while browsing', async () => {+ await openMenu();+ expect(optionCount()).toBe(FIELD_COUNT);+ });++ it('caps an extreme field list at the 1,000-row browsing ceiling', async () => {+ const extremeConfig: PowerSearchConfig = {+ name: 'ExtremeFields',+ fields: Array.from({length: 1001}, (_, i) => ({+ key: `extreme_${i}`,+ label: `Extreme ${i}`,+ defaultOperator: 'is',+ operators: [{key: 'is', label: 'is', value: {type: 'string'} as const}],+ })),+ };++ await openMenu(undefined, extremeConfig);+ expect(optionCount()).toBe(1000);+ });++ it('caps ranked results while typing', async () => {+ const user = await openMenu();+ // "zebra" matches every field label.+ await user.type(screen.getByRole('combobox'), 'zebra');+ await waitFor(() => {+ expect(optionCount()).toBe(10);+ });+ });++ it('caps ranked results at maxSearchResults while typing', async () => {+ const user = await openMenu({maxSearchResults: 3});+ await user.type(screen.getByRole('combobox'), 'zebra');+ await waitFor(() => {+ expect(optionCount()).toBe(3);+ });+ });++ it('does not apply maxSearchResults while browsing', async () => {+ await openMenu({maxSearchResults: 3});+ expect(optionCount()).toBe(FIELD_COUNT);+ });+});diff --git a/packages/core/src/PowerSearch/PowerSearch.tsx b/packages/core/src/PowerSearch/PowerSearch.tsxindex 58faab6fff..ac33b58e42 100644--- a/packages/core/src/PowerSearch/PowerSearch.tsx+++ b/packages/core/src/PowerSearch/PowerSearch.tsx@@ -79,6 +79,14 @@ import {useMergedRefs} from '../hooks/useMergedRefs';// Icon mapping for typeahead entries// =============================================================================+// Ranked suggestions shown for a non-empty query. The field list itself is+// never capped -- see the maxSearchResults prop.+const DEFAULT_MAX_SEARCH_RESULTS = 10;++// Empty-query browsing gets a high safety ceiling, matching XDS. This shows+// every practical field list without allowing an accidental unbounded DOM.+const MAX_BROWSE_MENU_ITEMS = 1000;+const OPERATOR_VALUE_TYPE_TO_ICON: Record<string, IconName> = {string: 'search',string_list: 'search',@@ -408,6 +416,12 @@ export interface PowerSearchProps extends Omit<maxTokenLength?: number;/** Max suggestions in string and entity value typeaheads. @default 10 */maxOperatorMenuItems?: number;+ /**+ * Max ranked results shown for a non-empty query. This does not affect the+ * value editor shown after selecting a field. Browsing the field list with+ * an empty query shows up to 1,000 fields. @default 10+ */+ maxSearchResults?: number;/** Label for the save button in edit popover. @default 'Apply' */popoverSaveButtonLabel?: string;/** Timezone ID for date formatting. */@@ -549,6 +563,7 @@ export function PowerSearch({statusVariant = 'attached',maxTokenLength = 40,maxOperatorMenuItems,+ maxSearchResults = DEFAULT_MAX_SEARCH_RESULTS,popoverSaveButtonLabel: popoverSaveButtonLabelFromProps,timezoneID,tokenOverflowBehavior,@@ -565,7 +580,7 @@ export function PowerSearch({}: PowerSearchProps) {const size = useSize(sizeProp, 'md');const config = useInternalConfig(configProp);- const searchSource = usePowerSearchSource(config);+ const searchSource = usePowerSearchSource(config, maxSearchResults);const t = useTranslator();const locale = useLocale();const label = labelFromProps ?? t('@astryx.powersearch.label');@@ -1051,6 +1066,7 @@ export function PowerSearch({onChange={handleTokenizerChange}renderToken={renderToken}renderItem={renderItem}+ maxMenuItems={MAX_BROWSE_MENU_ITEMS}placeholder={filters.length === 0 ? placeholder : ''}hasAutoFocus={hasAutoFocus}hasClear={hasClear && !isReadOnly}diff --git a/packages/core/src/PowerSearch/usePowerSearchSource.test.ts b/packages/core/src/PowerSearch/usePowerSearchSource.test.tsindex 24766c9c3d..b642ef2644 100644--- a/packages/core/src/PowerSearch/usePowerSearchSource.test.ts+++ b/packages/core/src/PowerSearch/usePowerSearchSource.test.ts@@ -21,10 +21,15 @@ import type {// Helpers// =============================================================================-function createSource(config: PowerSearchConfig) {+function createSource(+ config: PowerSearchConfig,+ // Uncapped by default so these tests exercise matching and ranking rather+ // than the typed-result cap, which has its own test below.+ maxTypedResults: number = Number.POSITIVE_INFINITY,+) {const {result} = renderHook(() => {const internal = useInternalConfig(config);- return usePowerSearchSource(internal);+ return usePowerSearchSource(internal, maxTypedResults);});return result.current;}@@ -539,3 +544,25 @@ describe('usePowerSearchSource', () => {});});});++describe('typed-result cap', () => {+ const manyFields: PowerSearchConfig = {+ name: 'many',+ fields: Array.from({length: 25}, (_, i) => ({+ key: `field_${i}`,+ label: `Zebra ${String(i).padStart(2, '0')}`,+ operators: [{key: 'is', label: 'is', value: {type: 'string'} as const}],+ })),+ };++ it('caps results for a typed query', () => {+ const source = createSource(manyFields, 10);+ expect(source.search('zebra')).toHaveLength(10);+ });++ it('never caps the field list for an empty query', () => {+ const source = createSource(manyFields, 10);+ expect(syncBootstrap(source)).toHaveLength(25);+ expect(source.search('')).toHaveLength(25);+ });+});diff --git a/packages/core/src/PowerSearch/usePowerSearchSource.ts b/packages/core/src/PowerSearch/usePowerSearchSource.tsindex f259b03f78..2dacb1414a 100644--- a/packages/core/src/PowerSearch/usePowerSearchSource.ts+++ b/packages/core/src/PowerSearch/usePowerSearchSource.ts@@ -19,8 +19,14 @@ import {resolveOperatorLabel} from './resolveOperatorLabel';import type {InternalConfig} from './useInternalConfig';import type {PowerSearchItem, PowerSearchOperator, FilterValue} from './types';+/**+ * @param maxTypedResults Cap applied to ranked results for a non-empty query.+ * The source never truncates empty-query browsing; PowerSearch's view applies+ * a separate 1,000-row safety ceiling.+ */export function usePowerSearchSource(config: InternalConfig,+ maxTypedResults: number,): SearchSource<PowerSearchItem> {const t = useTranslator();return useMemo(() => {@@ -198,14 +204,14 @@ export function usePowerSearchSource(}}- return results;+ return results.slice(0, maxTypedResults);},bootstrap(): PowerSearchItem[] {return allItems;},};- }, [config, t]);+ }, [config, t, maxTypedResults]);}interface ValueMatch {