Skip to content

Commit e3d0a94

Browse files
authored
Update BreakoutBanner docs information on leading visual accessible label (#839)
* updated docs with example and information on leadingVisual accessible lable * use a note for added prominence
1 parent 0f8bfa6 commit e3d0a94

File tree

1 file changed

+7
-1
lines changed
  • apps/docs/content/components/BreakoutBanner

1 file changed

+7
-1
lines changed

apps/docs/content/components/BreakoutBanner/react.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,14 @@ The content alignment can be changed using the `align` prop on the root `Breakou
100100

101101
### Leading visual
102102

103+
<Note variant="warning">
104+
An accessible label should always be provided for the leading visual.
105+
</Note>
106+
103107
```jsx live
104-
<BreakoutBanner leadingVisual={<LogoGithubIcon size="medium" />}>
108+
<BreakoutBanner
109+
leadingVisual={<LogoGithubIcon size="medium" aria-label="GitHub logo" />}
110+
>
105111
<BreakoutBanner.Heading>
106112
Where the most ambitious teams build great things
107113
</BreakoutBanner.Heading>

0 commit comments

Comments
 (0)