@renderlesskit/react/dist/types/utils/LiveAnnouncer.d.ts

Collection of headless components/hooks that are accessible, composable, customizable from low level to build your own UI & Design System powered by Reakit

import React from "react";
declare type TAriaLive = "assertive" | "off" | "polite" | undefined;
/**
 * Announces the message using screen reader technology.
 */
export declare function announce(message: string, assertiveness?: TAriaLive, timeout?: number): void;
/**
 * Stops all queued announcements.
 */
export declare function clearAnnouncer(assertiveness: TAriaLive): void;
/**
 * Removes the announcer from the DOM.
 */
export declare function destroyAnnouncer(): void;
export declare const LiveRegionAnnouncer: React.ForwardRefExoticComponent<React.RefAttributes<unknown>>;
export {};