npm

Need private packages and team management tools?Check out npm Orgs. »

accessible-navbar

0.0.10 • Public • Published

accessible-navbar

An extensible navigation bar with an accessible mobile menu.

Storybook examples

Install

yarn add accessible-navbar

and the peers...

yarn add focus-trap-react styled-components prop-types

Usage

import React from "react";
import { Navbar } from "accessible-navbar";
 
const Example = () => (
  <Navbar applicationNodeId="root">
    <a href="/">Home</a>
    <a href="/about">About</a>
    <a href="/contact">Contact</a>
  </Navbar>
);

Recipes

Take a look at the Storybook.

If you want to test the navbar with a screen reader or see the "The escape key closes the mobile menu" in action you'll have to press the "Open canvas in a new tab" button at the top right of your Storybook screen.

You can see the correct source code if you click the "story" tab in the addons section at the bottom of the screen. The "show info" button doesn't show the render-prop components correctly.

Accessibility ticks

The desktop menu is a <nav /> and the mobile menu is a modal with a <nav /> inside.

  • When the mobile menu is closed we don't render it into the dom.
  • When the mobile menu is open we add it at the end of the body (react portal).
  • The mobile menu has relevant aria attributes (for a modal).
  • The escape key closes the mobile menu.
  • When we open the mobile menu we transfer focus to the close button.
  • The focus is trapped inside the mobile menu, when open.
  • When we close the mobile menu the focus returns to the open button.
  • Clicking outside the mobile menu (if it's not full screen) closes the menu.
  • When the mobile menu is open we lock the scroll for the html element.

If you feel something is off, please let me know with an issue.

Available components

Navbar is a render props component that renders by default a DesktopList and a MobileList.

  • Navbar
  • DesktopList
  • DesktopListEmpty
  • MobileList
  • MobileListEmpty

They are all named exports:

import {
  Navbar,
  DesktopList,
  DesktopListEmpty,
  MobileList,
  MobileListEmpty
} from "accessible-navbar";

install

npm i accessible-navbar

Downloadsweekly downloads

16

version

0.0.10

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability