Skip to content

Commit 8a95b89

Browse files
authored
fix: Update documentation text for table area labels (#3564)
1 parent 64fb3a5 commit 8a95b89

File tree

2 files changed

+4
-10
lines changed

2 files changed

+4
-10
lines changed

src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17368,13 +17368,10 @@ scroll parent scrolls to reveal the first row of the table.",
1736817368
{
1736917369
"description": "Specifies alternative text for the selection components (checkboxes and radio buttons) as follows:
1737017370
* \`itemSelectionLabel\` ((SelectionState, Item) => string) - Specifies the alternative text for an item.
17371+
You can use the first argument of type \`SelectionState\` to access the current selection state of the component
17372+
(for example, the \`selectedItems\` list). The second argument is the corresponding \`Item\` object.
1737117373
* \`allItemsSelectionLabel\` ((SelectionState) => string) - Specifies the alternative text for multi-selection column header.
1737217374
* \`selectionGroupLabel\` (string) - Specifies the alternative text for the whole selection and single-selection column header.
17373-
It is prefixed to \`itemSelectionLabel\` and \`allItemsSelectionLabel\` when they are set.
17374-
You can use the first argument of type \`SelectionState\` to access the current selection
17375-
state of the component (for example, the \`selectedItems\` list). The \`itemSelectionLabel\` for individual
17376-
items also receives the corresponding \`Item\` object. You can use the \`selectionGroupLabel\` to
17377-
add a meaningful description to the whole selection.
1737817375
* \`tableLabel\` (string) - Provides an alternative text for the table. If you use a header for this table, you may reuse the string
1737917376
to provide a caption-like description. For example, tableLabel=Instances will be announced as 'Instances table'.
1738017377
* \`resizerRoleDescription\` (string) - Provides role description for table column resizer buttons.

src/table/interfaces.tsx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,13 +183,10 @@ export interface TableProps<T = any> extends BaseComponentProps {
183183
/**
184184
* Specifies alternative text for the selection components (checkboxes and radio buttons) as follows:
185185
* * `itemSelectionLabel` ((SelectionState, Item) => string) - Specifies the alternative text for an item.
186+
* You can use the first argument of type `SelectionState` to access the current selection state of the component
187+
* (for example, the `selectedItems` list). The second argument is the corresponding `Item` object.
186188
* * `allItemsSelectionLabel` ((SelectionState) => string) - Specifies the alternative text for multi-selection column header.
187189
* * `selectionGroupLabel` (string) - Specifies the alternative text for the whole selection and single-selection column header.
188-
* It is prefixed to `itemSelectionLabel` and `allItemsSelectionLabel` when they are set.
189-
* You can use the first argument of type `SelectionState` to access the current selection
190-
* state of the component (for example, the `selectedItems` list). The `itemSelectionLabel` for individual
191-
* items also receives the corresponding `Item` object. You can use the `selectionGroupLabel` to
192-
* add a meaningful description to the whole selection.
193190
* * `tableLabel` (string) - Provides an alternative text for the table. If you use a header for this table, you may reuse the string
194191
* to provide a caption-like description. For example, tableLabel=Instances will be announced as 'Instances table'.
195192
* * `resizerRoleDescription` (string) - Provides role description for table column resizer buttons.

0 commit comments

Comments
 (0)