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.

Sign up for GitHub

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

docs(IconButton): Add accessibility guidance for aria-labels #844

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(IconButton): Add accessibility guidance for aria-labels #844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions data/themes/docs/components/icon-button.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,22 @@ This component is based on the `button` element and supports [common margin prop

## Examples

{

<Callout.Root my="5" color="gray">
<Callout.Icon>
<InfoCircledIcon />
</Callout.Icon>
<Callout.Text>
It's strongly recommended to include
an <Code>aria-label</Code> prop on <Code>IconButton</Code> components since
they don't contain visible text.
Screen readers rely on this label to announce the button's purpose to users.
</Callout.Text>
</Callout.Root>

}

### Size

Use the `size` prop to control the size of the button.
Expand Down