Siirry sisältöön

Toast

Komponentti kelluvien tai push-tyyppisen ilmoitusten näyttämiseen.

Julkaistu versiossa 0.15.3

React API

Toast

  • as

    Renderöitävä HTML-elementti

    Tyyppi: ElementType

  • autoHide

    Määrittää katoaako toasti automaattisesti.

    Tyyppi: boolean

    Oletusarvo: true

  • autoHideDuration

    Määrittää kuinka kauan toasti pysyy näkyvissä.

    Tyyppi: number

    Oletusarvo: 10000

  • body
    Poistuva

    Ilmoituksen sisältö. @deprecated Poistuu versiossa 18.0.0. Siirrä sisältö children-elementtiin.

    Tyyppi: ReactNode

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • closeLabel

    Saavutettava teksti ilmoituksen sulkemispainikkeelle.

    Tyyppi: string

  • contentProps

    Toastin sisältöelementille välitettävät attribuutit.

    Tyyppi: Omit<HTMLAttributes<HTMLDivElement>, "onClick" | "ref"> & Record<string, string>

    Oletusarvo: {}

  • disableCloseRead
    Poistuva

    Poistaa Sulje-painikkeen lukemisen siirtämällä sulje-painikkeen role="alert":n ulkopuolelle. @deprecated Poistuu versiossa 18.0.0 ja toiminnasta tulee oletus.

    Tyyppi: boolean

    Oletusarvo: false

  • header
    Pakollinen

    Ilmoituksen otsikko.

    Tyyppi: string

  • onClick

    Ilmoituksen sulkemispainikkeen onClick-funktio.

    Tyyppi: (e: MouseEvent<HTMLButtonElement, MouseEvent>) => void

  • ref

    Komponentin ref, joka tyypittyy renderöitävän HTML-elementin mukaan.

    Tyyppi: any

  • testId

    Komponentin juurielementille data-testid-attribuuttiin välitettävä arvo testausta varten.

    Tyyppi: string

  • variant

    Ilmoituksen väri / tyyppi.

    Tyyppi: "primary" | "success"

ToastContainer

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • position

    Ilmoitusten sijainti näytöllä.

    Tyyppi: "top-right" | "bottom"

    Oletusarvo: top-right

  • srHeading

    Piilotettu otsikko ilmoituksille ruudunlukijoita varten.

    Tyyppi: string

  • srHeadingId

    Piilotetun otsikon id-attribuutti ankkurilinkkiä varten.

    Tyyppi: string

  • testId

    Komponentin juurielementille data-testid-attribuuttiin välitettävä arvo testausta varten.

    Tyyppi: string