@react-lit/skip-nav

0.4.4 • Public • Published

@react-lit/skip-nav

Renders a navigation link for screen readers and keyboard users to skip to the main content. The link is only visible if the user navigates via keyboard.

Installation

$ npm i @react-lit/skip-nav
# or
$ yarn add @react-lit/skip-nav

Example

import * as React from 'react';
import { SkipNavLink, SkipNavContent } from "@react-lit/skip-nav";

function Example() {
  return (
    {/* Put the link at the top of your app... */}
    <SkipNavLink />
    <div>
      <SomePresentationalContent />
      {/* ...and the content next to your main content. */}
      <SkipNavContent />
      <YourMainContent />
    </div>
  );
}

Development

(1) Install dependencies

$ npm i
# or
$ yarn

(2) Run initial validation

$ ./Taskfile.sh validate

(3) Run tests in watch-mode to validate functionality.

$ ./Taskfile test -w

This project was set up by @jvdx/core

Dependencies (0)

    Dev Dependencies (9)

    Package Sidebar

    Install

    npm i @react-lit/skip-nav

    Weekly Downloads

    3

    Version

    0.4.4

    License

    MIT

    Unpacked Size

    5.98 kB

    Total Files

    6

    Last publish

    Collaborators

    • joelvoss