Multiselect

API

Multiselect

Ref-prop välitetään komponentin valintapainike-elementille (button).

• a11yTextAllItemsRemoved

  Tyyppi: string

  Oletusarvo: Valinnat poistettu

  Ruudunlukijan lukema teksti kentän tyhjentyessä kaikista valinnoista

• a11yTextAvailableOptions

  Tyyppi: string

  Oletusarvo: Valittavien vaihtoehtojen lukumäärä on ${resultCount}, käytä nuoli ylös ja nuoli alas -näppäimiä siirtääksesi kohdistusta vaihtoehtojen välillä. Valitse vaihtoehto painamalla enter tai välilyönti -näppäintä.

  Ruudunlukijan lukema teksti valintojen päivittyessä hakua käytettäessä

• a11yTextNoSelectedItems

  Tyyppi: string

  Oletusarvo: Ei valintoja

  Ruudunlukijan lukema teksti, kun kohdistus siirretään kenttään, eikä valintoja ole tehtynä.

• disabled

  Tyyppi: boolean

  Oletusarvo: false

  Estetty (disabloitu) kenttä / linkki / painike

• errorText

  Tyyppi: string

  Virheilmoitus

• helpText

  Tyyppi: string

  Ohjeteksti (näytetään kentän yläpuolella)

• infoText

  Tyyppi: string

  Aputeksti (näytetään kentän alapuolella)

• initialSelectedItems

  Tyyppi: MultiselectOptions

  Oletusarvo: []

  Lista oletuksena valittuina näytettävistä valinnoista. Ei käytössä kun valintoja hallitaan komponentin ulkopuolelta selectedItems-propilla.

• inputWidth

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

  Select-kentän leveys (asetetaan antamalla palstaelementti)

• invalid

  Tyyppi: boolean

  Oletusarvo: false

  Virhetilanteen korostus

• items

  Pakollinen

  Tyyppi: MultiselectOptions

  Lista näytettävistä valinnoista

• itemsSelectedText

  Tyyppi: string

  Oletusarvo: valittu

  Kentässä valintojen lukumäärän perässä näytettävä teksti, kun useampi kuin yksi valinta on tehtynä

• labelText

  Tyyppi: ReactNode

  Kentän nimilappu

• leftCol

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

  Vasen palsta

• maxSelectedItems

  Tyyppi: number

  Rajoitus sallittujen valintojen lukumäärälle

• onBlur

  Tyyppi: (event: FocusEvent<HTMLElement, Element>) => void

  OnBlur-callback, kutsutaan kun fokus poistuu komponentista. Parametrina FocusEvent.

• onFilteredItemsChange

  Tyyppi: (selectedItems: MultiselectOptions) => void

  Valintoja suodatettaessa kutsuttava callback-funktio

• onSelectedItemsChange

  Tyyppi: (selectedItems: MultiselectOptions) => void

  Valintojen päivittyessä kutsuttava callback-funktio

• optionListEmptyStateMessage

  Tyyppi: string

  Oletusarvo: Ei tuloksia

  Teksti joka näytetään kun valintojen haku ei palauta tuloksia

• placeholder

  Tyyppi: string

  Oletusarvo: Valitse

  Valintapainikkeen placeholder-teksti

• ref

  Tyyppi: Ref<HTMLButtonElement>

• required

  Tyyppi: boolean

  Oletusarvo: false

  Pakollisen kentän korostus

• requiredLabel

  Tyyppi: string

  'Pakollinen tieto' -teksti

• resetButtonAriaLabel

  Tyyppi: string

  Oletusarvo: Tyhjennä valinnat

  Reset-painikkeen toimintaa kuvaava teksti ruudunlukijaa varten

• searchInputPlaceholderText

  Tyyppi: string

  Oletusarvo: Suodata valintoja

  Valintojen haku/suodatuskentän placeholder-teksti

• selectAllAriaLabel

  Tyyppi: string

  Valitse kaikki -valinnalle välitettävä aria-label

• selectAllLabel

  Tyyppi: string

  Valitse kaikki -valinnan teksti

• selectedItems

  Tyyppi: MultiselectOptions

  Komponentin näyttämät valinnat

• showReset

  Tyyppi: boolean

  Oletusarvo: true

  Näytä/piilota reset-painike, joka tyhjentää kaikki valinnat

• showSearch

  Tyyppi: boolean

  Oletusarvo: false

  Näytä/piilota valintojen hakukenttä valikon ollessa auki

• size

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

  Oletusarvo: md

  Mukautettu komponentin kokoluokka

• testId

  Tyyppi: string

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

• usePortal

  Tyyppi: boolean

  Oletusarvo: false

  Renderöi valikon portalin avulla. Estää valikon leikkautumisen jos parent-elementin overflow on piilotettu esim. taulukoissa.

• util

  Poistuva

  Tyyppi: string

  Utility-luokat ulkoasun muokkaamiseen @deprecated Poistuu käytöstä versiossa 15.0.0. Käytä className-proppia.

• variant

  Tyyppi: "filter" | "default"

  Oletusarvo: default

  Komponentin tyyppi. Filter-variantissa painikkeessa näytetään tekstinä nimilappu (labelText) ja tehtyjen valintojen lukumäärä.