Documentation
Feedback
Guides
Storefront Development

Storefront Development
Select

Selects allow users to pick an option from a predefined list.

Select components allow users to pick an option from a predefined list. The Select component should be used when there are more than 5 options available. Otherwise, consider using the RadioGroup component.

Overview

Example
Code

Import

Import the component from @faststore/ui

_10
import { Select } 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:

_10
@import '@faststore/ui/src/components/atoms/Select/styles.scss';

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

Usage


_10
<Select
_10
options={{
_10
great: 'Great',
_10
ok: 'Ok',
_10
bad: 'Bad',
_10
}}
_10
/>


Props

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-select
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-heightvar(--fs-spacing-6)
--fs-select-min-heightvar(--fs-control-tap-size)
--fs-select-paddingvar(--fs-spacing-1) var(--fs-spacing-5) var(--fs-spacing-1) var(--fs-spacing-2)
--fs-select-text-color
var(--fs-color-link)
--fs-select-border-radiusvar(--fs-border-radius)
--fs-select-bkgtransparent
--fs-select-bkg-color-focus
var(--fs-color-primary-bkg-light)
--fs-select-bkg-color-hover
var(--fs-select-bkg-color-focus)
--fs-select-transition-timingvar(--fs-transition-timing)
--fs-select-transition-propertyvar(--fs-transition-property)
--fs-select-transition-functionvar(--fs-transition-function)

Nested Elements

Icon

Local tokenDefault value/Global token linked
--fs-select-icon-color
var(--fs-color-link)
--fs-select-icon-position-rightvar(--fs-spacing-2)
--fs-select-icon-widthvar(--fs-spacing-3)
--fs-select-icon-heightvar(--fs-select-icon-width)

Variants

Disabled


_10
<Select
_10
id="select-disabled"
_10
options={{
_10
great: 'Great',
_10
ok: 'Ok',
_10
bad: 'Bad',
_10
}}
_10
disabled
_10
/>

Local tokenDefault value/Global token linked
--fs-select-disabled-text-color
var(--fs-color-disabled-text)
--fs-select-disabled-text-opacity1

Customization

For further customization, you can use the following data attributes:
data-fs-select
data-fs-select-icon

Best Practices

✅ Do's

  • Consider using a RadioGroup when few options are available. Doing so will prevent users from opening a dropdown box just to scan how many and which options are available.
  • Consider using an open text Input when several options are available and if the entries don’t need to be validated. Doing so will prevent users from having to read and understand all options before making a choice.
  • Consider using an autocomplete field when multiple options are available and if the inputs need to be validated.
  • Opt to grey out unavailable items instead of removing them completely.

  • SelectField

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

    See more
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page