Grid docs: explain sorter aria-label generation
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
aria-label attributes are autogenerated for Grid column sorters based on the text content in the sorter, prefixed by "Sort by ", so e.g. a column with the header text "Surname" would get aria-label="Sort by Surname". Currently this does not work with column headers with Components.
These details should be mentioned in the Grid documentation (e.g. under Sorting section, or in a separate Accessibility section).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the Grid documentation and its Sorting section, then review how accessibility details are currently described. Document that sorter aria-labels use the "Sort by " prefix and header text, including the limitation for column headers containing Components. Done means the behavior and limitation are clearly explained in the relevant documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100