Documentation
Feedback
Guides
Storefront Development

Storefront Development
Input

Inputs are fields used to get user inputs.

Overview

Example
Code

Import

Import the component from @faststore/ui

_10
import { Input } 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/Input/styles.scss'

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

Usage


_10
<Input placeholder="Input" />


Props

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-input

Design Tokens

Local tokenDefault value/Global token linked
--fs-input-paddingvar(--fs-spacing-1) var(--fs-spacing-2)
--fs-input-heightvar(--fs-control-tap-size)
--fs-input-bkg-colorvar(--fs-color-body-bkg)
--fs-input-box-shadownone
--fs-input-box-shadow-hover0 0 0 var(--fs-border-width) var(--fs-border-color-active)
--fs-input-text-color
var(--fs-color-text)
--fs-input-text-sizevar(--fs-text-size-body)
--fs-input-line-height1.25
--fs-input-transition-functionvar(--fs-transition-function)
--fs-input-transition-propertyvar(--fs-transition-property)
--fs-input-transition-timingvar(--fs-transition-timing)

Variants

Disabled


_10
<Input placeholder="Input" disabled />

Local tokenDefault value/Global token linked
--fs-input-disabled-bkg-color
var(--fs-color-disabled-bkg)
--fs-input-disabled-text-color
var(--fs-color-disabled-text)
--fs-input-disabled-border-width
var(--fs-border-width)
--fs-input-disabled-border-color
var(--fs-border-color)

Customization

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

Best Practices

✅ Do's

  • Provide a Label when using input. Descriptive labels help users understand the purpose of a form control.

  • InputField

    InputField wraps an Input and its corresponding Label.

    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