JSPM

@chakra-ui/live-region

0.0.0-dev-20220812060931
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 235646
  • Score
    100M100P100Q185388F
  • License MIT

Aria live region for React components

Package Exports

    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 (@chakra-ui/live-region) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    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>
      )
    }