Skip to content

Add aria-label to badge story and docs #4044

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

Merged
merged 6 commits into from
Feb 14, 2023
Merged

Add aria-label to badge story and docs #4044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9ac664d
Add aria-label to badge story
snowystinger Feb 10, 2023
5072c33
fix(4043): Move aria-label to CheckmarkCircle icon in Badge stories a…
Feb 13, 2023
ae5cb08
remove discouraged documentation example
Feb 14, 2023
c06ea66
Merge branch 'main' into add-aria-label-to-badge-story
snowystinger Feb 14, 2023
b26976b
Merge branch 'main' into add-aria-label-to-badge-story
Feb 14, 2023
f97c176
Merge branch 'main' into add-aria-label-to-badge-story
Feb 14, 2023
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
5 changes: 3 additions & 2 deletions packages/@react-spectrum/badge/docs/Badge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,14 @@ import {Text} from '@react-spectrum/text';
import CheckmarkCircle from '@spectrum-icons/workflow/CheckmarkCircle';

<Badge variant="positive">
<CheckmarkCircle />
<CheckmarkCircle aria-label="Done" />
<Text>Icon + Label</Text>
</Badge>
```

### Accessibility
If a visible label isn't specified, an `aria-label` must be provided for accessibility.
If a visible label isn't specified, an `aria-label` must be provided to the icon for accessibility.


### Internationalization

Expand Down
6 changes: 3 additions & 3 deletions packages/@react-spectrum/badge/stories/Badge.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ export const Default: BadgeStory = {
};

export const WithIcon: BadgeStory = {
args: {children: <><CheckmarkCircle /><Text>Licensed</Text></>, variant: 'positive'},
args: {children: <><CheckmarkCircle aria-label="Done" /><Text>Licensed</Text></>, variant: 'positive'},
name: 'With icon'
};

export const WithIconReverseOrder: BadgeStory = {
args: {children: <><Text>Licensed</Text><CheckmarkCircle /></>, variant: 'positive'},
args: {children: <><Text>Licensed</Text><CheckmarkCircle aria-label="Done" /></>, variant: 'positive'},
name: 'With icon, order reversed'
};

export const IconOnly: BadgeStory = {
args: {children: <CheckmarkCircle />, variant: 'positive', 'aria-label': 'Licensed'},
args: {children: <CheckmarkCircle aria-label="Licensed" />, variant: 'positive'},
name: 'Icon only'
};

Expand Down