<Enforma/> API

UsageAPIFormController API

Props

Prop	Type	Description
data	Object	The form data object
schema	Object	Optional form schema for schema-based rendering
validator	FormValidator	Validator instance (created with createEncolaValidator, createZodValidator, etc.)
submitHandler	Function	Function to be called on submit
config	Object	Form configuration options
showResetButton	Boolean	To show the reset button (default true)
showSubmitButton	Boolean	To show the submit button (default true). This is useful if you want to place the submit button outside the form
rules	Object	DEPRECATED: Use validator prop instead
messages	Object	DEPRECATED: Use validator prop instead

DEPRECATED PROPS

The :rules and :messages props are deprecated in v1.3.0. Use the :validator prop with a validator factory function instead:

<script setup>
import { createEncolaValidator } from '@encolajs/enforma/validators/encola'

const validator = createEncolaValidator(
  { firstName: 'required', email: 'required|email' },
  { 'firstName.required': 'First name is required' }
)
</script>
<template>
  <Enforma :data="formData" :validator="validator" />
</template>

See the Migration Guide for complete migration instructions.

Events

Event	Payload	Description
submit_error	formData	Emitted when there's an error while submitting the form
submit_success	formData	Emitted when the form is successfully submited
validation_fail	{ formController }	Emitted when validation fails. This is where you add notifications/toasts or scroll the form to the first field
validation_success	formData	Emitted when validation passes
field_change	{ path, value, fieldController, formController }	Emitted when any field value changes
field_blur	{ name, fieldController, formController }	Emitted when a field is blurred
field_focus	{ name, fieldController, formController }	Emitted when a field is focused

Slots

Slot	Props	Description
default	None	The main slot for form content where the fields are being rendered
actions	None	The place where the submit and reset buttons are being rendered