Skip to content

chore: improved LiveAnnouncer types #1210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dannify merged 4 commits into from
Nov 6, 2020
+21 −6
Merged

chore: improved LiveAnnouncer types #1210

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5780519
chore: improved LiveAnnouncer types
anuraghazra Oct 29, 2020
80463ae
Merge branch 'main' into liveannouncer-types
snowystinger Nov 2, 2020
57ea365
chore: use normal naming convention for types
anuraghazra Nov 3, 2020
aab4113
Merge branch 'liveannouncer-types' of https://github.com/anuraghazra/…
anuraghazra Nov 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions packages/@react-aria/live-announcer/src/LiveAnnouncer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,28 @@ let node = null;
let clearTimeoutId = null;
const LIVEREGION_TIMEOUT_DELAY = 1000;

type AriaLive = 'assertive' | 'off' | 'polite';

interface MessageProps {
message: string,
'aria-live': AriaLive
}

/**
* Announces the message using screen reader technology.
*/
export function announce(message: string, assertiveness = 'assertive', timeout = LIVEREGION_TIMEOUT_DELAY) {
export function announce(
message: string,
assertiveness: AriaLive = 'assertive',
timeout = LIVEREGION_TIMEOUT_DELAY
) {
ensureInstance(announcer => announcer.announce(message, assertiveness, timeout));
}

/**
* Stops all queued announcements.
*/
export function clearAnnouncer(assertiveness) {
export function clearAnnouncer(assertiveness: AriaLive) {
ensureInstance(announcer => announcer.clear(assertiveness));
}

Expand Down Expand Up @@ -66,7 +77,7 @@ const LiveRegionAnnouncer = React.forwardRef((props, ref) => {
let [assertiveMessage, setAssertiveMessage] = useState('');
let [politeMessage, setPoliteMessage] = useState('');

let clear = (assertiveness) => {
let clear = (assertiveness: AriaLive) => {
if (!assertiveness || assertiveness === 'assertive') {
setAssertiveMessage('');
}
Expand All @@ -76,7 +87,11 @@ const LiveRegionAnnouncer = React.forwardRef((props, ref) => {
}
};

let announce = (message, assertiveness = 'assertive', timeout = LIVEREGION_TIMEOUT_DELAY) => {
let announce = (
message,
assertiveness: AriaLive = 'assertive',
timeout = LIVEREGION_TIMEOUT_DELAY
) => {
if (clearTimeoutId) {
clearTimeout(clearTimeoutId);
clearTimeoutId = null;
Expand Down Expand Up @@ -108,7 +123,7 @@ const LiveRegionAnnouncer = React.forwardRef((props, ref) => {
);
});

function MessageAlternator({message = '', 'aria-live': ariaLive}) {
function MessageAlternator({message = '', 'aria-live': ariaLive}: MessageProps) {
let messagesRef = useRef(['', '']);
let indexRef = useRef(0);

Expand All @@ -126,7 +141,7 @@ function MessageAlternator({message = '', 'aria-live': ariaLive}) {
);
}

function MessageBlock({message = '', 'aria-live': ariaLive}) {
function MessageBlock({message = '', 'aria-live': ariaLive}: MessageProps) {
return (
<VisuallyHidden
aria-live={ariaLive}
Expand Down