Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add a11y considerations for accessible name #3640

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/pages/components/data-table/accessibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ Annotate if a table is sortable.
Keep this in mind if you are modifying Carbon or creating a custom component:

- Column sorting indicators are matched programmatically using `aria-sort`
- Remember to supply an `aria-label`, `aria-labelledby` or `title` to the
`Table` component to comply with
[accessible naming](https://able.ibm.com/rules/archives/latest/doc/en-US/aria_accessiblename_exists.html)
- See the
[ARIA authoring practices](https://www.w3.org/TR/wai-aria-practices-1.2/#table)
for more considerations
3 changes: 3 additions & 0 deletions src/pages/components/form/accessibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ creating a custom form or input component.
- A form must be wrapped in a `<form>` element.
- Required fields must be identified programmatically, either via the label or
with `aria-required`.
- Remember to supply an `aria-label`, `aria-labelledby` or `title` to the
component to comply with
[accessible naming](https://able.ibm.com/rules/archives/latest/doc/en-US/aria_accessiblename_exists.html)
- Helper text and other instructions should be surfaced to users via
`aria-describedby` or other accessible techniques. See
[Programmatically associate inputs with labels](https://www.ibm.com/able/toolkit/develop/user-input/#inputs).
Expand Down