fix(grid): Add aria-selected attribute handling for single select rows#3390
Draft
anna-lach wants to merge 14 commits into
Draft
fix(grid): Add aria-selected attribute handling for single select rows#3390anna-lach wants to merge 14 commits into
anna-lach wants to merge 14 commits into
Conversation
🦋 Changeset detectedLatest commit: 52d54ba The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds ARIA selection state handling to grid rows, improving accessibility for single-select rows and active-row behavior.
Changes:
- Adds computed
aria-selectedvalues to rendered data rows. - Adds tests for absence/presence and updates of
aria-selectedin default, single select, and activate modes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
packages/components/grid/src/grid.ts |
Computes and renders aria-selected for item rows based on selection or active-row state. |
packages/components/grid/src/grid.spec.ts |
Adds regression tests for aria-selected behavior across grid configurations. |
…on-missing-selected-state-for-single-select
…on-missing-selected-state-for-single-select # Conflicts: # packages/components/grid/src/grid.spec.ts
Contributor
🕸 Preview deploys |
…ility improvements
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Comments suppressed due to low confidence (1)
packages/components/grid/src/grid.ts:629
#onClickRownow expects the row index to avoidindexOfon the data source items (which can be aProxy). The click handler should pass the already-knownindex + 1into#onClickRow.
<tr
@click=${() => this.#onClickRow(item)}
@dragstart=${(event: DragEvent) => this.#onDragStart(event, item)}
| const secondRow = el.renderRoot.querySelector<HTMLTableRowElement>('tbody tr:nth-of-type(2)'); | ||
| expect(secondRow?.part.contains('selected')).to.be.true; | ||
| }); | ||
|
|
…r accessibility, announcer changes
Comment on lines
+612
to
+621
| ariaCurrent = | ||
| this.rowAction === 'activate' | ||
| ? active || selected | ||
| ? 'true' | ||
| : nothing | ||
| : (this.dataSource?.selects ?? this.selects) === 'single' | ||
| ? selected | ||
| ? 'true' | ||
| : nothing | ||
| : nothing; |
Comment on lines
+64
to
+67
| } else if (container?.textContent?.indexOf(event.detail.message) === -1) { | ||
| messageNode.innerText = event.detail.message; | ||
| } else { | ||
| return; |
| } | ||
|
|
||
| this.#announceSelection(item, index); | ||
| this.#skipNextFocusAnnounce = true; |
Comment on lines
+767
to
+775
| #announceSelection(item: ListDataSourceDataItem<T>, index: number): void { | ||
| const selected = | ||
| this.rowAction === 'activate' ? !!this.activeRow : !!this.dataSource?.isSelected(item); | ||
|
|
||
| announce( | ||
| selected | ||
| ? msg(str`Row ${index} activated`, { id: 'sl.grid.rowActivated' }) | ||
| : msg(str`Row ${index} deactivated`, { id: 'sl.grid.rowDeactivated' }), | ||
| 'assertive' |
Comment on lines
+109
to
+113
| it('should not have aria-selected when selects is not set', () => { | ||
| const rows = el.renderRoot.querySelectorAll<HTMLTableRowElement>('tbody tr'); | ||
|
|
||
| rows.forEach(row => { | ||
| expect(row).not.to.have.attribute('aria-selected'); |
…on-missing-selected-state-for-single-select
Comment on lines
631
to
633
| aria-rowindex=${index + 1} | ||
| aria-current=${ariaCurrent} | ||
| index=${index} |
Comment on lines
+786
to
+790
| const row = (event.target as HTMLElement)?.closest?.('tr'); | ||
|
|
||
| if (!row || !row.hasAttribute('aria-current')) { | ||
| return; | ||
| } |
Comment on lines
+767
to
+775
| #announceSelection(item: ListDataSourceDataItem<T>, index: number): void { | ||
| const selected = | ||
| this.rowAction === 'activate' ? !!this.activeRow : !!this.dataSource?.isSelected(item); | ||
|
|
||
| announce( | ||
| selected | ||
| ? msg(str`Row ${index} activated`, { id: 'sl.grid.rowActivated' }) | ||
| : msg(str`Row ${index} deactivated`, { id: 'sl.grid.rowDeactivated' }), | ||
| 'assertive' |
Comment on lines
+767
to
+801
| #announceSelection(item: ListDataSourceDataItem<T>, index: number): void { | ||
| const selected = | ||
| this.rowAction === 'activate' ? !!this.activeRow : !!this.dataSource?.isSelected(item); | ||
|
|
||
| announce( | ||
| selected | ||
| ? msg(str`Row ${index} activated`, { id: 'sl.grid.rowActivated' }) | ||
| : msg(str`Row ${index} deactivated`, { id: 'sl.grid.rowDeactivated' }), | ||
| 'assertive' | ||
| ); | ||
| } | ||
|
|
||
| #onFocusIn(event: FocusEvent): void { | ||
| // Skip the focus announcement if it was triggered by a click that is already announced | ||
| if (this.#skipNextFocusAnnounce) { | ||
| this.#skipNextFocusAnnounce = false; | ||
| return; | ||
| } | ||
|
|
||
| const row = (event.target as HTMLElement)?.closest?.('tr'); | ||
|
|
||
| if (!row || !row.hasAttribute('aria-current')) { | ||
| return; | ||
| } | ||
|
|
||
| const index = row.getAttribute('aria-rowindex'); | ||
|
|
||
| if (index) { | ||
| announce( | ||
| msg(str`In activated row ${index}`, { id: 'sl.grid.inActivatedRow' }), | ||
| 'assertive', | ||
| true | ||
| ); | ||
| } | ||
| } |
| @@ -429,7 +437,6 @@ describe('sl-grid', () => { | |||
| }); | |||
…on-missing-selected-state-for-single-select
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.