Siirry sisältöön

Alert

Komponentti ilmoitusten esittämiseen.

Julkaistu versiossa 0.15.3

React API

Alert

  • bgColor

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

    Tyyppi: "white" | "background"

  • children

    Komponentin sisältö

    Tyyppi: ReactNode

  • className

    CSS-apuluokat ulkoasun muokkaamiseen.

    Tyyppi: string

  • collapseTitle

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

    Tyyppi: string

  • collapseTitleAs

    Laajennettavan ilmoituksen painikkeen otsikon taso (h1-h6).

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

    Oletusarvo: h2

  • collapseTitleContainer

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

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

  • container

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

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

  • dismissible

    Suljettava ilmoitus

    Tyyppi: boolean

    Oletusarvo: false

  • flush

    Ilmoitus taustavärillä, ilman reunaviivoja

    Tyyppi: boolean

  • icon

    Ilmoituksen kuvake. Korvaa oletuskuvakkeen.

    Tyyppi: Element

  • iconAriaLabel

    Ikonille välitettävä aria-label

    Tyyppi: string

  • iconPosition

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

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

    Oletusarvo: auto

  • isOpen

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

    Tyyppi: boolean

  • onClick

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

    Tyyppi: () => void

  • onDismiss

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

    Tyyppi: () => void

  • size

    * Komponentin koko

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

    Oletusarvo: lg

  • testId

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

    Tyyppi: string

  • textOnly

    Ilmoitus, jossa on pelkkä kuvake ja teksti

    Tyyppi: boolean

  • variant
    Pakollinen

    Ilmoituksen tyyppi / väri

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