VisuallyHidden

VisuallyHidden is a common techinique used in web accessibility to hide content from the visual client, but keep it readable for screen readers.

Installation#

npm install @chakra-ui/react

Usage#

Example

function Example() {
  return (
    <Button>
      <VisuallyHidden>Checkmark</VisuallyHidden>
      <CheckIcon />
    </Button>
  )
}

Another Example

function Example() {
  return (
    <Box>
      <Heading>Title and description</Heading>
      <VisuallyHidden>This will be hidden</VisuallyHidden>
    </Box>
  )
}

Accessibility#

VisuallyHidden has all the styles necessary to hide it from visual clients, but keep it for screen readers.

Props#

This component doesn't have any custom props.