react-live-region
v1.0.2
Published
utility react component for offscreen live region
Downloads
10
Maintainers
Readme
react-live-region
A small react component for better web accessibility support for screen reader
Installation
$ npm i react-live-region --save
Usage
import ReactLiveRegion from 'react-live-region'
<ReactLiveRegion text="Success: announce message" />
Configuration
@param text
(String) - desire message to announce required
@param timeout
(Number) - time in millisecond to announce message default: 100
@param setting
(String) - aria-live = polite or assertive default: "polite"
@param atomic
(Boolean) ensures that each time the live region is updated, the entirety of the content is announced in full default: "false"
Use case
Conditionally show/hide to announce message
{ someCondition && <ReactLiveRegion text="Error: Invalid" />}