@carissa-io/components-visually-hidden
v0.1.1
Published
Carissa UI: visually hidden content as a React component with SCSS variables
Readme
@carissa-io/components-visually-hidden
Content that is hidden from the eye but still read by assistive technology: VisuallyHidden. It uses the clip pattern
(never display: none, which removes the content from the accessibility tree). With focusable it becomes visible while
it, or something inside it, has keyboard focus: the usual shape of a skip link. A React component, SCSS-themed, with no
dependencies.
npm i @carissa-io/components-visually-hiddenUse
import { VisuallyHidden } from '@carissa-io/components-visually-hidden'
<button type="button">
<TrashIcon /> <VisuallyHidden>{t('delete')}</VisuallyHidden>
</button>
<VisuallyHidden as="a" href="#main" focusable>{t('skip_to_content')}</VisuallyHidden>| Prop | |
|---|---|
| as | the element to render: a tag name, span by default; anything that is not a non-empty string falls back to span |
| focusable | false by default; when true the content is revealed while it or a child has focus |
| className, id, href, … | className is appended; unknown props go to the element |
Accessibility notes
- The content is not
aria-hiddenand nothidden: screen readers read it in the normal order. - A
focusableelement must be focusable by itself (a link, a button, or an element withtabindex="0"), otherwise there is nothing to reveal; put it first in the page for a skip link. - Do not use it to hide text that has a visual equivalent which is already read, to avoid reading it twice.
Style
@use '@carissa-io/components-visually-hidden/scss' with (
$c-visually-hidden-focus-background: #fff,
$c-visually-hidden-focus-color: #111
);Classes: c-visually-hidden and c-visually-hidden--focusable. The hidden state has no variables (it is the clip
pattern). Every variable below is !default and only styles the revealed focusable state (see
scss/_variables.scss).
| Variable | Default |
|---|---|
| $c-visually-hidden-focus-position | fixed |
| $c-visually-hidden-focus-top, $c-visually-hidden-focus-left | 0.5rem |
| $c-visually-hidden-focus-z-index | 1000 |
| $c-visually-hidden-focus-padding | 0.5rem 1rem |
| $c-visually-hidden-focus-background | Canvas |
| $c-visually-hidden-focus-color | CanvasText |
