Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 832 Bytes

README.md

File metadata and controls

31 lines (21 loc) · 832 Bytes

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" />}