directus/docs/reference/app/components/v-form.md

Form

Renders a form using interfaces based on the passed collection name.

<v-form
	collection="articles"
	v-model="{}"
	:initial-values="{
		title: 'Hello World'
	}"
/>

Reference

Props

Prop	Description	Default	Type
collection	The collection of which you want to render the fields	undefined	String
fields	Array of fields to render. This can be used instead of the collection prop	undefined	Field[]
initial-values	Object of the starting values of the fields	null	FieldValues
model-value	The edits that were made after the form was rendered. Being used in v-model	null	FieldValues
loading	Display the form in a loading state. Prevents the ctx menus from being used and renders skeleton loaders for the fields	false	Boolean
batch-mode	If enabled, allows to select multiple entries	false	Boolean
primary-key	The primary key of the given collection	null	[String, Number]
disabled	Disables any interaction with the form	false	Boolean
validation-errors	Add custom validation to any field	() => []	ValidationError[]

Note: You have to pass either the collection or fields prop.

Slots

n/a

Events

Event	Description	Value
update:model-value	Edits have been updated.