Package Exports

@real-system/visually-hidden
@real-system/visually-hidden/lib/index.esm.js
@real-system/visually-hidden/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@real-system/visually-hidden) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@real-system/visually-hidden

Real System's screen-reader-only component.

Usage

Installation

# install peer dependencies

# npm
$ npm install --save @real-system/styling @real-system/box react react-dom
# yarn
$ yarn add @real-system/styling @real-system/box react react-dom

# install visually-hidden

# npm
$ npm install --save @real-system/visually-hidden
# yarn
$ yarn add @real-system/visually-hidden

Code Example

import { ThemeProvider } from '@real-system/theme';
import { VisuallyHidden } from '@real-system/visually-hidden';

const MyComponent = () => {
  return (
    <ThemeProvider>
      <VisuallyHidden>Screen reader only text</VisuallyHidden>
    </ThemeProvider>
  );
};