Tooltip

React API

Tooltip

• children

  Komponentin sisältö. Elementti, joka avaa työkaluvihjeen, kun kohdistus siirtyy siihen. Ominaisuus ei ole käytössä isPopover-propin kanssa.

  Tyyppi: ReactNode & Element

• className

  CSS-apuluokat ulkoasun muokkaamiseen.

  Tyyppi: string

• closeButtonLabel

  Sulje-painikkeen saavutettava nimilappu. Sallii myös kohdistuksen siirtämisen painikkeeseen.

  Tyyppi: string

• content

  Pakollinen

  Työkaluvihjeen sisältö.

  Tyyppi: string | Element

• hoverDelay

  Hover-tilan viive millisekunteina.

  Tyyppi: number

• id

  Työkaluvihjeen ikonille tai painikkeelle välitettävä id.

  Tyyppi: string

• isPopover

  Asettaa käyttöön klikkaamalla avautuvan version työkaluvihjeestä.

  Tyyppi: boolean

  Oletusarvo: false

• isVisualOnly

  Muuttaa työkaluvihjeen vain visuaaliseksi. Käytetään tilanteessa, jossa painikkeen saavutettava nimilappu on sama kuin työkaluvihjeen sisältö.

  Tyyppi: boolean

  Oletusarvo: false

• mode

  Määrittää pidetäänkö työkaluvihjeen HTML-rakenne DOM:ssa vai poistetaanko se suljetulta työkaluvihjeeltä. Ominaisuus ei ole käytössä isPopover-propin kanssa. Huom! Ruudunlukijat lukevat hover-tilan paremmin static-vaihtoehdolla.

  Tyyppi: "static" | "dynamic"

  Oletusarvo: static

• placement

  Työkaluvihjeen ensisijainen asemointi. Tilan loppuessa Työkaluvihje voi siirtyä avautumaan toiselta puolelta.

  Tyyppi: "top" | "top-start" | "top-end" | "right" | "right-start" | "right-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end"

  Oletusarvo: top

• placementStrategy

  Työkaluvihjeen asemointiin käytettävä CSS-määritys.

  Tyyppi: "absolute" | "fixed"

  Oletusarvo: absolute

• popoverButtonClassName

  Klikkaamalla avautuvan työkaluvihjeen painikkeelle välitettävä CSS-luokka.

  Tyyppi: string

• popoverIcon

  Klikkaamalla avautuvan työkaluvihjeen ikoni.

  Tyyppi: Element

• popoverIconLabel

  Klikkaamalla avautuvan työkaluvihjeen saavutettava nimilappu.

  Tyyppi: string

  Oletusarvo: Työkaluvihje

• showCloseButton

  Määrittää näytetäänkö työkaluvihjeen sulje-painike. Klikkaamalla avautuvan työkaluvihjeen painike näytetään aina.

  Tyyppi: boolean

  Oletusarvo: false

• size

  Mukautettu komponentin kokoluokka

  Tyyppi: "xs" | "sm" | "md"

• testId

  Komponentin juurielementille data-testid-attribuuttiin välitettävä tunniste testausta varten. Tooltipin aktivoivalle elementille (esim. Button) välitettävä data-testid-attribuutti. TestId-proppia voi käyttää, kun aktivoiva elementti on KDS-komponentti, joka tukee testId-proppia. Natiiville HTML-elementille voi antaa suoraan data-testid-attribuutin.

  Tyyppi: string

• usePortal

  Estää tarvittaessa työkaluvihjeen leikkautumisen sijoittamalla työkaluvihjeen sivun loppuun.

  Tyyppi: boolean