package.dist.index.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of live-region Show documentation

Implementing live region for screen readers

The newest version!

interface LiveRegionOptions {
    level: "polite" | "assertive";
    document?: Document | undefined;
    root?: HTMLElement | null | undefined;
    delay?: number | undefined;
}
type LiveRegion = ReturnType;
declare function createLiveRegion(opts?: Partial): {
    announce: (message: string, delay?: number) => void;
    destroy: () => void;
    toJSON(): string;
};

export { type LiveRegion, type LiveRegionOptions, createLiveRegion };