Skip to content

Commit 50ec699

Browse files
committed
refactor(CNavbar): update aria-* behavior
1 parent 27a811b commit 50ec699

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

docs/4.0/components/CNavbar.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Adding images to the `<CNavbarBrand>` will likely always require custom styles o
152152
<CNavbar expand="lg" colorScheme="light" className="bg-light">
153153
<CContainer fluid>
154154
<CNavbarBrand href="#">Navbar</CNavbarBrand>
155-
<CNavbarToggler onClick={() => setVisible(!visible)} />
155+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
156156
<CCollapse className="navbar-collapse" visible={visible}>
157157
<CNavbarNav>
158158
<CNavItem>
@@ -188,7 +188,7 @@ And because we use classes for our navs, you can avoid the list-based approach e
188188
<CNavbar expand="lg" colorScheme="light" className="bg-light">
189189
<CContainer fluid>
190190
<CNavbarBrand href="#">Navbar</CNavbarBrand>
191-
<CNavbarToggler onClick={() => setVisible(!visible)} />
191+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
192192
<CCollapse className="navbar-collapse" visible={visible}>
193193
<CNavbarNav component="nav">
194194
<CNavLink href="#" active>
@@ -218,7 +218,7 @@ You can also use dropdowns in your navbar. Please note that `<CDropdown>` compon
218218
<CNavbar expand="lg" colorScheme="light" className="bg-light">
219219
<CContainer fluid>
220220
<CNavbarBrand href="#">Navbar</CNavbarBrand>
221-
<CNavbarToggler onClick={() => setVisible(!visible)} />
221+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
222222
<CCollapse className="navbar-collapse" visible={visible}>
223223
<CNavbarNav>
224224
<CNavItem>
@@ -327,7 +327,7 @@ Theming the navbar has never been easier thanks to the combination of theming cl
327327
<CNavbar expand="lg" colorScheme="dark" className="bg-dark">
328328
<CContainer fluid>
329329
<CNavbarBrand href="#">Navbar</CNavbarBrand>
330-
<CNavbarToggler onClick={() => setVisible(!visible)} />
330+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
331331
<CCollapse className="navbar-collapse" visible={visible}>
332332
<CNavbarNav>
333333
<CNavItem>
@@ -364,7 +364,7 @@ Theming the navbar has never been easier thanks to the combination of theming cl
364364
<CNavbar expand="lg" colorScheme="dark" className="bg-primary">
365365
<CContainer fluid>
366366
<CNavbarBrand href="#">Navbar</CNavbarBrand>
367-
<CNavbarToggler onClick={() => setVisible(!visible)} />
367+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
368368
<CCollapse className="navbar-collapse" visible={visible}>
369369
<CNavbarNav>
370370
<CNavItem>
@@ -401,7 +401,7 @@ Theming the navbar has never been easier thanks to the combination of theming cl
401401
<CNavbar expand="lg" colorScheme="light" style={{backgroundColor: '#e3f2fd'}}>
402402
<CContainer fluid>
403403
<CNavbarBrand href="#">Navbar</CNavbarBrand>
404-
<CNavbarToggler onClick={() => setVisible(!visible)} />
404+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
405405
<CCollapse className="navbar-collapse" visible={visible}>
406406
<CNavbarNav>
407407
<CNavItem>
@@ -520,7 +520,7 @@ With no `<CNavbarBrand>` shown at the smallest breakpoint:
520520
<>
521521
<CNavbar expand="lg" colorScheme="light" className="bg-light">
522522
<CContainer fluid>
523-
<CNavbarToggler onClick={() => setVisible(!visible)} />
523+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
524524
<CCollapse className="navbar-collapse" visible={visible}>
525525
<CNavbarBrand href="#">Hidden brand</CNavbarBrand>
526526
<CNavbarNav className="me-auto mb-2 mb-lg-0">
@@ -560,7 +560,7 @@ With a brand name shown on the left and toggler on the right:
560560
<CNavbar expand="lg" colorScheme="light" className="bg-light">
561561
<CContainer fluid>
562562
<CNavbarBrand href="#">Navbar</CNavbarBrand>
563-
<CNavbarToggler onClick={() => setVisible(!visible)} />
563+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
564564
<CCollapse className="navbar-collapse" visible={visible}>
565565
<CNavbarNav className="me-auto mb-2 mb-lg-0">
566566
<CNavItem>
@@ -598,7 +598,7 @@ With a toggler on the left and brand name on the right:
598598
<>
599599
<CNavbar expand="lg" colorScheme="light" className="bg-light">
600600
<CContainer fluid>
601-
<CNavbarToggler onClick={() => setVisible(!visible)} />
601+
<CNavbarToggler aria-label="Toggle navigation" aria-expanded={visible} onClick={() => setVisible(!visible)} />
602602
<CNavbarBrand href="#">Navbar</CNavbarBrand>
603603
<CCollapse className="navbar-collapse" visible={visible}>
604604
<CNavbarNav className="me-auto mb-2 mb-lg-0">

src/components/navbar/CNavbarToggler.tsx

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,7 @@ export const CNavbarToggler = forwardRef<HTMLButtonElement, CNavbarTogglerProps>
1414
const _className = classNames('navbar-toggler', className)
1515

1616
return (
17-
// TODO: aria-expanded="false"
18-
<button
19-
type="button"
20-
className={_className}
21-
aria-label="Toggle navigation"
22-
{...rest}
23-
ref={ref}
24-
>
17+
<button type="button" className={_className} {...rest} ref={ref}>
2518
{children ? children : <span className="navbar-toggler-icon"></span>}
2619
</button>
2720
)

0 commit comments

Comments
 (0)