Siirry sisältöön

14.5.0

Beta

DatePickerV2

Komponentti yksittäisen päivämäärän syöttämiseen tai valitsemiseen kalenterinäkymästä.

Julkaistu versiossa 13.3.0

API

DatePickerV2

Ref-prop välitetään komponentin input-elementille.

  • calendarDefaultMonth

    Tyyppi: DatePickerV2Value

    Kuukausi, johon kalenteri aukeaa (Date-objekti tai tekstimuotoinen arvo YYYY-MM).

  • children

    Tyyppi: ReactNode

    Komponentin sisältö

  • className

    Tyyppi: string

    Utility-luokat ulkoasun muokkaamiseen

  • defaultValue

    Tyyppi: DatePickerV2Value

    Päivämäärävalinnan oletusarvo, kun käytetään ei-kontrolloituna komponenttina.

  • disablePast

    Tyyppi: boolean

    Estää kuluvaa päivää aiemman valinnan.

  • disabled

    Tyyppi: boolean

    Estetty kenttä

  • disabledDates

    Tyyppi: DatePickerV2DisabledDates[]

    Päivämäärät, joiden valinta on estetty.

  • errorText

    Tyyppi: string

    Kentän virheilmoitusteksti.

  • errorTextId

    Tyyppi: string

    Input-kentälle välitettävä id virheviestille (käytettävissä räätölöityihin virheviesteihin).

  • fixedCalendarHeight

    Tyyppi: boolean

    Oletusarvo: true

    Näyttää kalenterissa aina 6 viikkoa, jotta sen korkeus ei muutu kuukautta vaihdettaessa.

  • fromDate

    Tyyppi: DatePickerV2Value

    Päivämäärä, josta alkaen valintoja voidaan tehdä (Date-objekti tai tekstimuotoinen arvo YYYY-MM-DD).

  • helpText

    Tyyppi: string

    Kentän täyttöohje, joka näytetään kentän yläpuolella.

  • id

    Tyyppi: string

    Päivämäärän valintakentän (input) id

  • infoText

    Tyyppi: string

    Kentän aputeksti, joka näytetään kentän alapuolella.

  • inputTestId

    Tyyppi: string

    Komponentin input-kentän data-testid-attribuuttiin välitettävä arvo testausta varten.

  • inputWidth

    Tyyppi: (children: ReactNode) => ReactElement<any, string | JSXElementConstructor<any>>

    Kentän leveys (asetetaan antamalla Column-palstaelementti)

  • invalid

    Tyyppi: boolean

    Oletusarvo: false

    Virheellisen kentän korostus

  • labelText

    Tyyppi: ReactNode

    Kentän nimilappu

  • leftCol

    Tyyppi: (children: ReactNode) => ReactElement<any, string | JSXElementConstructor<any>>

    Vasen palsta

  • localization

    Tyyppi: Partial<DatePickerV2Localization>

    Kalenterinäkymän lokalisointi

  • onBlur

    Tyyppi: (event: FocusEvent<HTMLInputElement, Element>, validity?: DateValidationResult) => void

    Callback-funktio, jota kutsutaan kun kohdistus siirtyy pois input-kentästä. Parametreina FocusEvent ja DateValidationResult.

  • onChange

    Tyyppi: (dateValue: string, validity?: DateValidationResult) => void

    Callback-funktio, jota kutsutaan input-kentän arvon muuttuessa. Parametreina input-kentän arvo ja DateValidationResult.

  • onError

    Tyyppi: (dateValue: string, validity?: DateValidationResult) => void

    Callback-funktio, jota kutsutaan vain virhetilanteessa. Parametreina input-kentän arvo ja DateValidationResult.

  • onSelect

    Tyyppi: (dateValue: string, validity?: DateValidationResult) => void

    Callback-funktio, jota kutsutaan kun päivämäärä valitaan kalenterista. Parametreina input-kenttään päivittyvä arvo ja DateValidationResult.

  • placeholder

    Tyyppi: string

    Oletusarvo: pp.kk.vvvv

    Input-kentän placeholder-teksti

  • ref

    Tyyppi: ForwardedRef<HTMLInputElement>

  • required

    Tyyppi: boolean

    Oletusarvo: false

    Pakollisen kentän korostus.

  • requiredLabel

    Tyyppi: string

    "Pakollinen tieto" -teksti ruudunlukijalle.

  • showDropdownNavigation

    Tyyppi: boolean

    Näyttää kalenterinäkymässä vuosi- ja kuukausivalinnat alasvetovalikossa (Huom! Vaatii, että fromDate ja toDate -propeille on asetettu arvot rajoittamaan valintojen määrää).

  • showLeadingZeros

    Tyyppi: boolean

    Oletusarvo: true

    Hallitsee etunollien näyttämistä input-kenttään asetetussa päivämääräarvossa (01.01.2023 vs. 1.1.2023). Oletuksena etunollat näytetään.

  • showWeekNumbers

    Tyyppi: boolean

    Näyttää viikkonumerot kalenterissa.

  • size

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

    Oletusarvo: md

    Mukautettu komponentin kokoluokka

  • testId

    Tyyppi: string

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

  • toDate

    Tyyppi: DatePickerV2Value

    Päivämäärä, johon asti valintoja voidaan tehdä (Date-objekti tai tekstimuotoinen arvo YYYY-MM-DD).

  • value

    Tyyppi: string

    Päivämäärävalinnan arvo tekstimuodossa kun käytetään kontrolloituna komponenttina (pp.kk.vvvv tai vvvv-kk-pp).