ProComponentsProse

FieldGroup

Group fields together in a list.

Usage

validate (path?: string, opts: { silent?: boolean })
Promise<T>

Triggers form validation. Will raise any errors unless opts.silent is set to true.

clear (path?: string)
void

Clears form errors associated with a specific path. If no path is provided, clears all form errors.

getErrors (path?: string)
FormError[]

Retrieves form errors associated with a specific path. If no path is provided, returns all form errors.

setErrors (errors: FormError[], path?: string)
void

Sets form errors for a given path. If no path is provided, overrides all errors.

errors
Ref<FormError[]>

A reference to the array containing validation errors. Use this to access or manipulate the error information.

::field-group
  ::field{name="validate (path?: string, opts: { silent?: boolean })" type="Promise<T>"}
  Triggers form validation. Will raise any errors unless `opts.silent` is set to true.
  ::
  ::field{name="clear (path?: string)" type="void"}
  Clears form errors associated with a specific path. If no path is provided, clears all form errors.
  ::
  ::field{name="getErrors (path?: string)" type="FormError[]"}
  Retrieves form errors associated with a specific path. If no path is provided, returns all form errors.
  ::
  ::field{name="setErrors (errors: FormError[], path?: string)" type="void"}
  Sets form errors for a given path. If no path is provided, overrides all errors.
  ::
  ::field{name="errors" type="Ref<FormError[]>"}
  A reference to the array containing validation errors. Use this to access or manipulate the error information.
  ::
::