@fremtind/jkl-react-hooks
Version:
Jøkul react button components
16 lines (15 loc) • 684 B
TypeScript
export interface UseAriaLiveRegionOptions {
/**
* @default "polite"
*/
politeness?: "polite" | "assertive" | "off";
}
/**
* Hjelper for å bare sette aria-live dersom det har skjedd en endring. Unngår at innholdet annonseres ved sidelasting.
* @param watch Verdi som indikerer at det har skjedd en endring. For eksempel en boolean som styrer en loader, eller selve teksten som skal bli lest opp.
* @param options Bestem om aria-live skal være polite, assertive eller off.
* @returns
*/
export declare function useAriaLiveRegion(watch: unknown | unknown[], options?: UseAriaLiveRegionOptions): {
"aria-live": "polite" | "assertive" | "off" | undefined;
};