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

Select Field

Select Field wraps a Select input and its corresponding Label. It allows users to select one option from a set.

Overview


Import

Import the component from @faststore/ui

import { SelectField } 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/atoms/Select/styles.scss';
@import '@faststore/ui/src/components/molecules/SelectField/styles.scss';

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


Usage

<SelectField
  id="select-order-by"
  label="Order by:"
  options={{
    name_asc: 'Name, A-Z',
    name_desc: 'Name, Z-A',
    top_sales: 'Top Sales',
  }}
/>

Props

NameTypeDescriptionDefault
label*stringDefines the text displayed in the label right next to the Select.
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-select-field
id*stringAssigns an identifier to link the UISelect component and its label.
options*Record<string, string>Defines the options available in the select. The SelectOptions object keys are the property names, while the values correspond to the text that will be displayed in the UI.

Design Tokens

Local tokenDefault value/Global token linked
--fs-select-label-color
var(--fs-color-text-light)
--fs-select-label-margin-rightvar(--fs-spacing-1)

Customization

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

data-fs-select-field

data-fs-select-field-label