Skip to content

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

TypeScript

docs(table): remove JS comment from useTableSelection @example block (#4324)

Joey3290b8aa6719
diff --git a/packages/core/src/Table/plugins/selection/useTableSelection.tsx b/packages/core/src/Table/plugins/selection/useTableSelection.tsx
index e61909e335..ca851a4f27 100644
--- a/packages/core/src/Table/plugins/selection/useTableSelection.tsx
+++ b/packages/core/src/Table/plugins/selection/useTableSelection.tsx
@@ -72,11 +72,12 @@ export interface UseTableSelectionConfig<T extends Record<string, unknown>> {
* Derive a human-readable identity for a row, used in the row checkbox's
* hidden label as `Select ${getRowLabel(item)}`. Without it, every row
* checkbox announces an undifferentiated "Select row" to screen readers.
+ * With `getRowLabel: item => item.name`, checkbox accessible names become
+ * "Select Alice", "Select Bob", and so on.
*
* @example
* ```
* getRowLabel: item => item.name
- * // Checkbox accessible names: "Select Alice", "Select Bob", ...
* ```
*/
getRowLabel?: (item: T) => string;