Siirry sisältöön

Alert

Komponentti ilmoitusten esittämiseen.

Julkaistu versiossa 0.15.3

React API

Alert

  • bgColor

    Tyyppi: "white" | "background"

    Ilmoituksen taustaväri. Ei ole käytössä laajennettavan ilmoituksen kanssa.

  • children

    Tyyppi: ReactNode

    Komponentin sisältö

  • className

    Tyyppi: string

    CSS-apuluokat ulkoasun muokkaamiseen.

  • collapseTitle

    Tyyppi: string

    Laajennettavan ilmoituksen otsikkoteksti. Pidä otsikko lyhyenä ja käytä yhdessä onClick ja isOpen -proppien kanssa.

  • collapseTitleAs

    Tyyppi: ElementType<HTMLAttributes<HTMLElement>, keyof IntrinsicElements>

    Oletusarvo: h2

    Laajennettavan ilmoituksen painikkeen otsikon taso (h1-h6).

  • collapseTitleContainer

    Tyyppi: ({ children }: { children: ReactNode; }) => Element

    Render-prop laajennettavan ilmoituksen painikkeen sisälle tulevan containerin renderöimiseen. Käytä inline-elementtiä, kuten span.

  • container

    Tyyppi: ({ children }: { children: ReactNode; }) => Element

    Render-prop ilmoituksen sisällön containerin renderöimiseen.

  • dismissible

    Tyyppi: boolean

    Oletusarvo: false

    Suljettava ilmoitus

  • flush

    Tyyppi: boolean

    Ilmoitus taustavärillä, ilman reunaviivoja

  • icon

    Tyyppi: Element

    Ilmoituksen kuvake. Korvaa oletuskuvakkeen.

  • iconAriaLabel

    Tyyppi: string

    Ikonille välitettävä aria-label

  • iconPosition

    Tyyppi: "left" | "top" | "auto"

    Oletusarvo: auto

    Ikonin sijainti. Oletuksena ikoni on vasemmalla. Ei ole käytössä laajennettavan ilmoituksen kanssa.

  • isOpen

    Tyyppi: boolean

    Määrittää onko laajennettava ilmoitus auki vai kiinni.

  • onClick

    Tyyppi: () => void

    Funktio, jota kutsutaan, kun laajennettava ilmoitus avataan ja suljetaan.

  • onDismiss

    Tyyppi: () => void

    Funktio, jota kutsutaan, kun ilmoitus poistetaan näkyvistä (dismissible).

  • size

    Tyyppi: "sm" | "md" | "lg"

    Oletusarvo: lg

    * Komponentin koko

  • testId

    Tyyppi: string

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

  • textOnly

    Tyyppi: boolean

    Ilmoitus, jossa on pelkkä kuvake ja teksti

  • variant

    Pakollinen

    Tyyppi: "primary" | "warning" | "danger" | "success" | "light"

    Ilmoituksen tyyppi / väri