Form

Form provides unified structure, alignment, and styling for a user's form fields.

installyarn add @react-spectrum/form
version3.0.0-rc.2
usageimport {Form} from '@react-spectrum/form'
View repository
GitHub
View package
NPM

Example#

<h3 id="label-1">Login</h3>
<Form width={400} aria-labelledby="label-1">
  <TextField label="Email" placeholder="abc@adobe.com" />
  <TextField label="Password" placeholder="1234" />
  <Checkbox>Remember me</Checkbox>
</Form>

Content#

Form accepts one or more children to render as its form elements. Label alignment, positioning, and other properties are set on the Form itself and propagated to its children to generate a cohesive design. To override these top level Form props on individual children, set them directly on the child instead.

<h3 id="label-2">Sign Up</h3>
<Form width={400} aria-labelledby="label-2" isRequired necessityIndicator="label">
  <TextField label="Name" placeholder="Bob Doe" />
  <TextField label="Email" placeholder="abc@adobe.com" />
  <TextField label="Address" placeholder="123 Any Street" isRequired={false} />
</Form>

Accessibility#

As per W3 Form guidelines, the controls provided to the form should use native host semantics (button, input, select, textarea) whenever possible. React Spectrum components such as Button, TextField, and TextArea all satisfy this criteria.

Labeling#

Accessibility#

A label should be provided to the Form by adding either the aria-label or aria-labelledby prop, so that the element will be identified to assistive technology as a form landmark region to which assistive technology can navigate to.

<h3 id="label-3">Personal Information</h3>
<Form width={400} aria-labelledby="label-3">
  <TextField label="First Name" placeholder="Bob" />
  <TextField label="Last Name" placeholder="Dole" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
    <Radio value="dragons">Dragons</Radio>
  </RadioGroup>
</Form>

Props#

NameTypeDefaultDescription
childrenReactElement<SpectrumLabelableProps> | ReactElement<SpectrumLabelableProps>[]—The contents of the Form.
isQuietboolean—Whether the Form elements are displayed with their quiet style.
isEmphasizedboolean—Whether the Form elements are rendered with their emphasized style.
isDisabledboolean—Whether the Form elements are disabled.
isRequiredboolean—Whether user input is required on each of the Form elements before Form submission.
isReadOnlyboolean—Whether the Form elements can be selected but not changed by the user.
validationStateValidationState"valid"Whether the Form elements should display their "valid" or "invalid" visual styling.
labelPositionLabelPosition"top"The label's overall position relative to the element it is labeling.
labelAlignAlignment"start"The label's horizontal alignment relative to the element it is labeling.
necessityIndicatorNecessityIndicator"icon"Whether the required state should be shown as an icon or text.
labelReactNode—The content to display as the label.
Layout
NameTypeDefaultDescription
flexstring | number | boolean—When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumber—When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumber—When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumber | string—When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'—Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'—Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumber—The layout order for the element within a flex or grid container. See MDN.
gridAreastring—When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstring—When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstring—When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstring—When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstring—When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstring—When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstring—When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValue—The margin for all four sides of the element. See MDN.
marginTopDimensionValue—The margin for the top side of the element. See MDN.
marginBottomDimensionValue—The margin for the bottom side of the element. See MDN.
marginStartDimensionValue—The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValue—The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValue—The margin for both the left and right sides of the element. See MDN.
marginYDimensionValue—The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValue—The width of the element. See MDN.
minWidthDimensionValue—The minimum width of the element. See MDN.
maxWidthDimensionValue—The maximum width of the element. See MDN.
heightDimensionValue—The height of the element. See MDN.
minHeightDimensionValue—The minimum height of the element. See MDN.
maxHeightDimensionValue—The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'—Specifies how the element is positioned. See MDN.
topDimensionValue—The top position for the element. See MDN.
bottomDimensionValue—The bottom position for the element. See MDN.
leftDimensionValue—The left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValue—The right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValue—The logical start position for the element, depending on layout direction. See MDN.
endDimensionValue—The logical end position for the element, depending on layout direction. See MDN.
zIndexnumber—The stacking order for the element. See MDN.
isHiddenboolean—Hides the element.
Accessibility
NameTypeDefaultDescription
rolestring—
idstring—
tabIndexnumber—
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-hiddenboolean | 'false' | 'true'—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestring—Sets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSProperties—Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Label position and label alignment#

<Form labelPosition="top" labelAlign="start" aria-label="Form example: label position=top, label alignment=start " width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

<Form labelPosition="top" labelAlign="end" aria-label="Form example: label position=top, label alignment=end" width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

<Form labelPosition="side" labelAlign="start" aria-label="Form example: label position=side, label alignment=start" width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

<Form labelPosition="side" labelAlign="end" aria-label="Form example: label position=side, label alignment=end" width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

Quiet#

<Form isQuiet aria-label="Form example: isQuiet" width={400}>
  <TextField label="Name" placeholder="John Smith" />
  <TextField label="Address" placeholder="123 Any Street" />
</Form>

Emphasized#

<Form isEmphasized aria-label="Form example: isEmphasized" width={400}>
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

Disabled#

<Form isDisabled aria-label="Form example: isDisabled" width={400}>
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

Required and necessity indicator#

<Form necessityIndicator="label" aria-label="Form example: optional with necessityIndicator=label" width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

<Form isRequired necessityIndicator="label" aria-label="Form example: isRequired with necessityIndicator=label" width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

<Form isRequired necessityIndicator="icon" aria-label="Form example: isRequired with necessityIndicator=icon" width={400} >
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

Read only#

<Form isReadOnly aria-label="Form example: isReadOnly" width={400}>
  <TextField label="Name" value="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

Validation state#

<Form validationState="invalid" aria-label="Form example: validationState=invalid" width={400} marginBottom="20px">
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>

<Form validationState="valid" aria-label="Form example: validationState=valid" width={400}>
  <TextField label="Name" placeholder="John Smith" />
  <RadioGroup label="Favorite pet" name="favorite-pet-group">
    <Radio value="dogs">Dogs</Radio>
    <Radio value="cats">Cats</Radio>
  </RadioGroup>
</Form>