useAriaLive

React API

Parametrit

• ref

  Reactin Ref-objekti.

  Tyyppi: RefObject<E> | MutableRefObject<E>

• options

  Asetukset, joilla voi muokata ilmoitusten toimintaa.

  Tyyppi: UseAriaLiveOptions

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  ariaAtomic	boolean	-
  ariaLive	"polite" | "assertive" | "off"	-
  className	string	kds-sr-only
  cleanupTimeout	number	500
  shouldCleanup	boolean	true
  suppressError	boolean	true

Paluuarvot

• announce

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

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

• ariaLiveProps

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

  Tyyppi: object

  Parametrit

  Nimi	Tyyppi	Oletusarvo
  ariaAtomic	boolean	-
  ariaLive	"polite" | "assertive" | "off"	-
  className	string	-
  ref	RefObject<E> | MutableRefObject<E>	-