Skip to content

joelvoss/react-lit-visually-hidden

Repository files navigation

@react-lit/visually-hidden

Render text that is announced to screen readers but visually hidden.

Installation

$ npm i @react-lit/visually-hidden
# or
$ yarn add @react-lit/visually-hidden

Example

import * as React from 'react',
import { VisuallyHidden } from '@react-lit/visually-hidden';

function Example() {
  return (
    <button>
      <VisuallyHidden>Close</VisuallyHidden>
      <span aria-hidden>🔒</span>
    </button>
  )
}

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

About

Render text that is announced to screen readers but visually hidden.

Resources

License

Stars

Watchers

Forks