feat(design-system): [OCISDEV-399] add table caption #13224
Merged
Conversation
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
We added a caption to the `OcTable` component. It's content can be set via a newly introduced `caption` prop. The visibility of the caption can also be toggled via new `captionVisible` prop. By default, it is visible only to screen readers. If the `OcTable` includes any sortable columns, the caption will automatically include screen reader only explanation of sorting capabilities. This makes sure that screen readers are not overriding column headers with actions via `aria-label` and that it does not repeat the same action multiple times. All of this behavior is directly inspired by the ARIA Authoring Practices Guide (APG): https://www.w3.org/WAI/ARIA/apg/patterns/table/examples/sortable-table/
There was a problem hiding this comment.
Pull Request Overview
This PR adds accessibility improvements to the OcTable component by introducing a table caption feature. The caption provides screen reader users with information about the table and its sorting capabilities, following ARIA Authoring Practices Guide (APG) recommendations.
Key Changes:
- Added
captionandcaptionVisibleprops toOcTablecomponent - Automatically generates screen reader text explaining sortable columns
- Removed redundant
aria-labelattributes from sort buttons in favor of caption-based explanation - Modified
aria-sortattribute handling to only set values when actively sorting
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/design-system/src/components/OcTable/OcTable.vue | Implements caption functionality, removes aria-label from sort buttons, refactors aria-sort attribute handling |
| packages/design-system/src/components/OcTable/OcTable.sort.spec.ts | Updates tests to reflect new aria-sort behavior (only set when actively sorting) |
| changelog/unreleased/enhancement-add-table-caption.md | Documents the new feature |
| packages/web-app-files/tests/unit/views/trash/snapshots/Overview.spec.ts.snap | Updates snapshot with new caption element and removed aria-label |
| packages/web-app-admin-settings/tests/unit/views/snapshots/Users.spec.ts.snap | Updates snapshot with new caption element and removed aria-label/aria-sort |
| packages/web-app-admin-settings/tests/unit/components/Spaces/snapshots/SpacesList.spec.ts.snap | Updates snapshot with new caption element and removed aria-label/aria-sort |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
mzner
approved these changes
Oct 20, 2025
|
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.
Description
We added a caption to the
OcTablecomponent. It's content can be set via a newly introducedcaptionprop. The visibility of the caption can also be toggled via newcaptionVisibleprop. By default, it is visible only to screen readers. If theOcTableincludes any sortable columns, the caption will automatically include screen reader only explanation of sorting capabilities. This makes sure that screen readers are not overriding column headers with actions viaaria-labeland that it does not repeat the same action multiple times. All of this behavior is directly inspired by the ARIA Authoring Practices Guide (APG).Motivation and Context
Adjustments after accessibility audit.
How Has This Been Tested?
Types of changes