Skip to content

Commit f847cd0

Browse files
snowystingerMichael Jordan
andauthored
Add aria-label to badge story and docs (#4044)
* Add aria-label to badge story * fix(4043): Move aria-label to CheckmarkCircle icon in Badge stories and docs * remove discouraged documentation example --------- Co-authored-by: Michael Jordan <[email protected]>
1 parent 5389f12 commit f847cd0

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

packages/@react-spectrum/badge/docs/Badge.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,14 @@ import {Text} from '@react-spectrum/text';
5151
import CheckmarkCircle from '@spectrum-icons/workflow/CheckmarkCircle';
5252

5353
<Badge variant="positive">
54-
<CheckmarkCircle />
54+
<CheckmarkCircle aria-label="Done" />
5555
<Text>Icon + Label</Text>
5656
</Badge>
5757
```
5858

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

6263
### Internationalization
6364

packages/@react-spectrum/badge/stories/Badge.stories.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ export const Default: BadgeStory = {
3737
};
3838

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

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

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

0 commit comments

Comments
 (0)