<HeadlessField> API

UsageAPI

A field component that provides no UI, just the field state and logic.

Props

Prop	Type	Required	Description
name	String	Yes	Field name/path
validateOn	String	No	When to validate this field ( 'input' | 'change' | 'blur' | 'submit')
validateOnMount	Boolean	No	Whether to validate when the componet mounts

Slots

Slot	Props	Description
default	fieldCtrl	The default slot receives the field controller.

Field Controller

The field controller is an object that provides properties and methods for managing the field state and behavior.

Properties

Property	Type	Description
id	string	The unique ID of the field.
value	any	The current value of the field. It is also included in the attrs
error	string	The error message if the field is invalid. It is the first error message from the array of error messages
attrs	object	HTML attributes for the field.
events	object	Event handlers for the field.
model	{ value: any }	A reactive object that can be used with v-model for two-way binding. The model property will only trigger validation when the field is dirty.

It is recommend to **NOT use** the `model` as you won't be able to control when the field gets validated. If you do use it, you shouldn't pass the `onChange` and `onInput` events to the input.