jsDocs.io logo

@reach/visually-hidden

  • Version 0.17.0
  • Published
  • 10.9 kB
  • 2 dependencies
  • MIT license

Install

npm i @reach/visually-hidden
yarn add @reach/visually-hidden
pnpm add @reach/visually-hidden

Overview

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

Index

Variables

Interfaces

Variables

variable VisuallyHidden

const VisuallyHidden: Polymorphic.ForwardRefComponent<'span', VisuallyHiddenProps>;

  • VisuallyHidden

    Provides text for screen readers that is visually hidden. It is the logical opposite of the aria-hidden attribute.

Interfaces

interface VisuallyHiddenProps

interface VisuallyHiddenProps {}

  • See Also

    • Docs https://reach.tech/visually-hidden#visuallyhidden-props

property children

children: React.ReactNode;

  • See Also

    • Docs https://reach.tech/visually-hidden#visuallyhidden-children

Package Files (2)

Dependencies (2)

Dev Dependencies (2)

Peer Dependencies (2)

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@reach/visually-hidden.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@reach/visually-hidden)
  • HTML
    <a href="https://www.jsdocs.io/package/@reach/visually-hidden"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>