Components
CheckboxField
Code

CheckboxField

Checkbox field with label and help message

<CheckboxField>Label</CheckboxField>

Parameters

props

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

Props

error (optional)

Whether the field contains an error or not

  • Type: boolean

  • Default: false

errorText (optional)

Error message

  • Type: @types/react.React.ReactNode

helpText (optional)

Help message

  • Type: @types/react.React.ReactNode

indeterminate (optional)

  • Type: boolean

value (optional)

  • Type: string

View source (opens in a new tab)