Skip to content

Commit

Permalink
chore(docs): add a11y considerations for accessible name (#3640)
Browse files Browse the repository at this point in the history
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
  • Loading branch information
francinelucca and kodiakhq[bot] authored Jul 12, 2023
1 parent 1887005 commit e197160
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
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

1 comment on commit e197160

@vercel
Copy link

@vercel vercel bot commented on e197160 Jul 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.