Skip to content

A small component for better web accessibility support for screen reader

Notifications You must be signed in to change notification settings

pagesource/react-live-region

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A small component for better web accessibility support for screen reader

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published