@chakra-ui/live-region
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

Live Regions

ARIA Live Regions are used to communicate important information to screen reader software.

Installation

yarn add @chakra-ui/live-region

Import components

import { LiveRegion, useLiveRegion } from "@chakra-ui/live-region"

Usage

import { useLiveRegion } from "@chakra-ui/live-region"

function Example() {
  const region = useLiveRegion()
  return (
    <button
      onClick={() => {
        region.speak("Filtering categories was successful")
      }}
    >
      Click me
    </button>
  )
}

Package Sidebar

Install

npm i @chakra-ui/live-region

Weekly Downloads

434,484

Version

2.1.0

License

MIT

Unpacked Size

42 kB

Total Files

22

Last publish

Collaborators

  • segunadebayo
  • _codebender828