@hakuna-matata-ui/visually-hidden
Version:
A React component that visually hides its content
37 lines (24 loc) • 806 B
Markdown
# @hakuna-matata-ui/visually-hidden
The visually hidden component styles itself so that it’s content is not visible,
but it is available to assistive technologies like screen readers and other text
to speech programs.
## Installation
```sh
yarn add @hakuna-matata-ui/visually-hidden
# or
npm i @hakuna-matata-ui/visually-hidden
```
## Import component
```jsx
import { VisuallyHidden } from "@hakuna-matata-ui/visually-hidden"
```
## Basic usage
```jsx
// it renders a `span` by default
<VisuallyHidden>This content will be hidden on screen</VisuallyHidden>
// for visually hidden input fields
<VisuallyHiddenInput type="checkbox" defaultChecked/>
```
## References
- https://snook.ca/archives/html_and_css/hiding-content-for-accessibility
- https://a11yproject.com/posts/how-to-hide-content/