TextField

TextField enables the user to type in text information. It has an input, a label, and an optional helper text. It supports several input types like text or password etc. It can be disabled or have a validation state. The label can be hidden or show if the input is required.

Basic example usage:


                                                
                                                <TextField id="textFieldDefault" name="textFieldDefault" />

Advanced example usage:


                                                
                                                <TextField
                                                  helperText="custom helper text"
                                                  id="textFieldAdvanced"
                                                  isRequired
                                                  label="Label"
                                                  name="textFieldAdvanced"
                                                  placeholder="Placeholder"
                                                  type="text"
                                                  validationState="danger"
                                                  validationText="validation failed"
                                                />

TextField with password toggle (button to reveal the password):


                                                
                                                <TextField
                                                  hasPasswordToggle
                                                  id="textFieldPasswordToggle"
                                                  isRequired
                                                  label="Password"
                                                  name="textFieldPasswordToggle"
                                                  placeholder="Placeholder"
                                                  validationState="danger"
                                                  validationText="validation failed"
                                                />

API

Name	Type	Default	Required	Description
autoComplete	bool	—	✕	Automated assistance in filling
hasPasswordToggle	bool	—	✔	If true, the type is set to password and a password toggle is shown
helperText	string	—	✕	Custom helper text
id	string	—	✕	Input and label identification
inputWidth	number	—	✕	Input width
isDisabled	bool	—	✕	Whether is field disabled
isLabelHidden	bool	—	✕	Whether is label hidden
isRequired	bool	—	✕	Whether is field required
label	string	—	✕	Label text
name	string	—	✕	Input name
pattern	string	—	✕	Defines regular expressions for allowed value types
placeholder	string	—	✕	Input placeholder
ref	ForwardedRef<HTMLInputElement>	—	✕	Input element reference
type	[email \| number \| password \| search \| tel \| text \| url]	—	✕	Input type
validationState	Validation dictionary	—	✕	Type of validation state
validationText	[string \| string[]]	—	✕	Validation text
value	string	—	✕	Input value

On top of the API options, the components accept additional attributes. If you need more control over the styling of a component, you can use style props and escape hatches.

Custom component

Text field classes are fabricated using useTextFieldStyleProps hook. You can use it to create your own custom TextField component.


                                                
                                                const CustomTextField = (props: SpiritTextFieldProps): JSX.Element => {
                                                  const { classProps, props: modifiedProps } = useTextFieldStyleProps(props);
                                                
                                                  return (
                                                    <div className={classProps.root}>
                                                      <input {...modifiedProps} className={classProps.input} />
                                                      <label htmlFor={props.id} className={styleProps.label}>
                                                        {props.label}
                                                      </label>
                                                    </div>
                                                  );
                                                };

For detailed information see TextField component.

Text Field

Live code

Storybook

Usage

TextField

API

Custom component