ToggleSwitch

React API

ToggleSwitch

• checked

  Tyyppi: boolean

  Valinnan tila kun komponenttia käytetään kontrolloidusti

• defaultChecked

  Tyyppi: boolean

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

• helpText

  Tyyppi: string

  Kentän ohjeteksti

• inline

  Tyyppi: boolean

  Tulostaa nimilapun ja painikkeen samalle riville

• labelText

  Tyyppi: string

  Kentän nimilappu

• leftCol

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

  Kaksipalstaiselle asettelulle (asetetaan antamalla palstaelementti)

• onClick

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

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

• size

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

  Komponentin koko

• stateLabel

  Tyyppi: ToggleSwitchStateLabel

  Valitun tilan nimilaput (on/off)

• testId

  Tyyppi: string

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

• variant

  Tyyppi: "primary" | "neutral"

  Oletusarvo: primary

  Painikkeen värivariantti