⚠️ After March 18, 2024, the FastStore documentation will be migrated to the Developer Portal. For more information, access the official release note.

Toggle Field

Toggle Field wraps a Toggle input and its corresponding Label.

Overview


Import

Import the component from @faststore/ui

import { ToggleField } from '@faststore/ui'

Import Styles into your FastStore project

To apply the styles of this component in your FastStore project, import the following into your stylesheet:

@import '@faststore/ui/src/components/molecules/ToggleField/styles.scss' @import
  '@faststore/ui/src/components/molecules/Toggle/styles.scss';

Follow the instructions in the Importing FastStore UI component styles tutorial.


Usage

<ToggleField id="toggle-field-example" label="Toggle Label" />

Props

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-toggle-field
id*stringID to identify input and corresponding label.
label*stringThe text displayed to identify the input.
displayLabelfalse | trueControls whether the label will be displayed or not.true
disabledfalse | trueSpecifies that this input should be disabled.
variant"horizontal" | "vertical"Controls the component's direction.horizontal

Customization

For further customization, you can use the following data attributes:

data-fs-toggle-field

data-fs-toggle-field-label