Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(typeahead): clarify ignored TypeaheadItem group prop (#9744)

zakelstorm87d5159ae670
diff --git a/.changeset/typeahead-item-group-docs.md b/.changeset/typeahead-item-group-docs.md
new file mode 100644
index 0000000000..05f32379d9
--- /dev/null
+++ b/.changeset/typeahead-item-group-docs.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[docs] TypeaheadItem: the docs say that the `group` prop has no effect, and that results are grouped through `item.auxiliaryData.group` on search-source items.
+
+@korkt-kim
diff --git a/packages/core/src/Typeahead/TypeaheadItem.doc.mjs b/packages/core/src/Typeahead/TypeaheadItem.doc.mjs
index c773f4d23e..bfb9299dbb 100644
--- a/packages/core/src/Typeahead/TypeaheadItem.doc.mjs
+++ b/packages/core/src/Typeahead/TypeaheadItem.doc.mjs
@@ -43,7 +43,8 @@ export const docs = {
{
name: 'group',
type: 'string',
- description: 'Group label for grouping items visually.',
+ description:
+ 'This prop has no effect. Set `item.auxiliaryData.group` on search-source items to group results in Typeahead or BaseTypeahead.',
},
],
};
@@ -79,7 +80,8 @@ export const docsZh = {
{
name: 'group',
type: 'string',
- description: '用于视觉分组的分组标签。',
+ description:
+ '此属性不影响渲染。要在 Typeahead 或 BaseTypeahead 中分组,请在搜索源返回的结果项上设置 `item.auxiliaryData.group`。',
},
],
};
@@ -94,6 +96,7 @@ export const docsDense = {
icon: 'Icon/avatar before label.',
description: 'Text below label.',
isDisabled: 'Visually disabled.',
- group: 'Group label for visual grouping.',
+ group:
+ 'No effect. Group results via `item.auxiliaryData.group` in the search source.',
},
};
diff --git a/packages/core/src/Typeahead/TypeaheadItem.tsx b/packages/core/src/Typeahead/TypeaheadItem.tsx
index 5225970b1e..f74950acfb 100644
--- a/packages/core/src/Typeahead/TypeaheadItem.tsx
+++ b/packages/core/src/Typeahead/TypeaheadItem.tsx
@@ -54,7 +54,8 @@ export interface TypeaheadItemProps<
isDisabled?: boolean;
/**
- * Group label for grouping items visually.
+ * This prop has no effect. Set `item.auxiliaryData.group` on search-source
+ * items to group results in Typeahead or BaseTypeahead.
*/
group?: string;
}