@chakra-ui/visually-hidden

What is @chakra-ui/visually-hidden?

@chakra-ui/visually-hidden is a utility component from the Chakra UI library that allows you to visually hide elements while keeping them accessible to screen readers. This is particularly useful for improving accessibility in web applications.

What are @chakra-ui/visually-hidden's main functionalities?

Visually Hidden Text

This feature allows you to hide text visually while keeping it accessible to screen readers. This is useful for providing additional context to screen reader users without displaying the text on the screen.

<VisuallyHidden>This text is hidden but accessible to screen readers</VisuallyHidden>

Visually Hidden Input

You can use the VisuallyHidden component to hide form elements like inputs while keeping them accessible. This is useful for hidden form fields that need to be read by screen readers.

<VisuallyHidden as="input" type="text" value="hidden input" />

Other packages similar to @chakra-ui/visually-hidden

react-aria

react-aria provides a set of React hooks that help you build accessible components. It includes utilities for managing focus, keyboard interactions, and more. Compared to @chakra-ui/visually-hidden, react-aria offers a broader range of accessibility utilities but requires more setup.

react-accessible-accordion

react-accessible-accordion is a component library for creating accessible accordions in React. While it focuses on a specific UI pattern, it shares the goal of improving accessibility, similar to @chakra-ui/visually-hidden.

README

@chakra-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

yarn add @chakra-ui/visually-hidden

# or

npm i @chakra-ui/visually-hidden

Import component

import { VisuallyHidden } from "@chakra-ui/visually-hidden"

Basic usage

// 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/