API Reference

Implementation of a fieldset

<Field>
  <Label>Label</Label>
  <Input />
  <FieldDescription>Short description</FieldDescription>
  <FieldError>Error message</FieldError>
</Field>

Parameters

props

• Type: @vtex/shoreline-components.FieldProps & @types/react.React.RefAttributes<typescript.HTMLDivElement>

Props

asChild (optional)

Enables component composition

• Type: boolean

• Default: false

error (optional)

Whether the field is in an error state

• Type: boolean

• Default: false

space (optional)

Space between the field's children

• Type: normal | large

• Default: 'normal'

View source (opens in a new tab)