JSPM

@chakra-ui/skip-nav

2.0.12
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 264001
  • Score
    100M100P100Q197281F
  • License MIT

Skip navigation links for screen reader and keyboard users

Package Exports

  • @chakra-ui/skip-nav
  • @chakra-ui/skip-nav/package.json

Readme

@chakra-ui/skip-nav

Skip navigation link for screen reader and keyboard users. Because the main content is not usually the first thing in the document, it is valuable to provide a shortcut for keyboard and screen reader users to skip to the content.

If the user does not navigate with the keyboard, they won't see the link.

Install

npm i @chakra-ui/skip-nav
# or
yarn add @chakra-ui/skip-nav

Import

import { SkipNavLink, SkipNavContent } from "@chakra-ui/skip-nav"

Usage

ReactDOM.render(
  <>
    {/* 👇🏻 put the link at the top of your app */}
    <SkipNavLink>Skip to content</SkipNavLink>
    <div>
      <Navbar />
      {/* 👇🏻 and the content next to your main content */}
      <SkipNavContent>
        <App />
      </SkipNavContent>
    </div>
  </>,
  rootNode,
)