ToggleSwitch

React API

ToggleSwitch

• checked

  Valinnan tila kun komponenttia käytetään kontrolloidusti

  Tyyppi: boolean

• defaultChecked

  Valinnan oletustila. Käytössä vain kun komponenttia käytetään ei-kontrolloidusti.

  Tyyppi: boolean

• helpText

  Kentän ohjeteksti

  Tyyppi: string

• inline

  Tulostaa nimilapun ja painikkeen samalle riville

  Tyyppi: boolean

• labelText

  Kentän nimilappu

  Tyyppi: string

• leftCol

  Kaksipalstaiselle asettelulle (asetetaan antamalla palstaelementti)

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

• onClick

  Callback-funktio, jota kutsutaan kun painiketta klikataan. Parametrina MouseEvent ja valinnan tilan arvo.

  Tyyppi: ((event: MouseEvent<HTMLButtonElement, MouseEvent>, checked: boolean) => void) & MouseEventHandler<HTMLButtonElement>

• size

  Komponentin koko

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

• stateLabel

  Valitun tilan nimilaput (on/off)

  Tyyppi: ToggleSwitchStateLabel

• testId

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

  Tyyppi: string

• variant

  Painikkeen värivariantti

  Tyyppi: "primary" | "neutral"

  Oletusarvo: primary