useAriaLive

API

Parametrit

• ref

  Tyyppi: RefObject<E> | MutableRefObject<E>

  Reactin Ref-objekti.

• options

  Tyyppi: UseAriaLiveOptions

  Oletusarvo: { ariaAtomic: undefined, ariaLive: "polite", className: "kds-sr-only", cleanupTimeout: 500, shouldCleanup: true, suppressError: true }

  Asetukset, joilla voi muokata ilmoitusten toimintaa.

Paluuarvot

• ariaLiveProps

  Tyyppi: { "aria-atomic": boolean, "aria-live": "polite" | "assertive" | "off", className: string, ref: RefObject<E> | MutableRefObject<E> }

  Propit elementille, johon ilmoitusteksti lisätään.

• announce

  Tyyppi: (announcement: string) => () => void

  Funktio, varsinaisen ilmoituksen tekemiseen. Palauttaa cleanup-funktion, jolla voi manuaalisesti siivota ilmoituksen.