createInput

Shared form field primitive with validation state, ARIA ID generation, and automatic form registration.

Copy Markdown

Preview Advanced Apr 5, 2026

Usage

import { createInput } from '@vuetify/v0'
import { ref } from 'vue'

const value = ref('')
const input = createInput({
  value,
  rules: [v => !!v || 'Required'],
})

// Field state
input.isDirty.value      // false (no content)
input.isPristine.value   // true (unchanged)
input.isTouched.value    // false (not interacted)

// Trigger validation
await input.validate()
input.isValid.value      // false
input.errors.value       // ['Required']
input.state.value        // 'invalid'

// Update value
value.value = 'hello'
input.isDirty.value      // true
input.isPristine.value   // false

// Reset
input.reset()
value.value              // '' (initial value)
input.isPristine.value   // true
input.isValid.value      // null (unvalidated)

Architecture

Reactivity

Property	Type	Description
`value`	`Ref<T>`	The field value (same ref passed in)
`isDirty`	`Readonly<Ref<boolean>>`	Has content (via `dirty` predicate)
`isPristine`	`Readonly<Ref<boolean>>`	Unchanged since mount/reset
`isFocused`	`ShallowRef<boolean>`	Writable — component sets on focus/blur
`isTouched`	`ShallowRef<boolean>`	Writable — component sets after first interaction
`isDisabled`	`Readonly<Ref<boolean>>`	Resolved from `disabled` option
`isReadonly`	`Readonly<Ref<boolean>>`	Resolved from `readonly` option
`errors`	`Readonly<Ref<string[]>>`	Merged validation + manual errors
`isValid`	`Readonly<Ref<boolean \| null>>`	Tri-state: null (unvalidated), true, false
`isValidating`	`Readonly<Ref<boolean>>`	Async validation in progress
`state`	`Readonly<Ref<InputState>>`	`'pristine' \| 'valid' \| 'invalid'`

Method	Description
`validate()`	Run rules, returns `Promise<boolean>`
`reset()`	Restore initial value, clear validation

Tip

isDirty and isPristine are not inverses. A pre-filled form field is dirty AND pristine. A cleared field is not-dirty AND not-pristine.

Generic Types

createInput is generic over the value type:

// String (default) — for text inputs
createInput({ value: ref('') })

// Number | null — for numeric inputs
createInput<number | null>({
  value: ref<number | null>(null),
  dirty: v => v !== null,
  equals: (a, b) => Object.is(a, b),
})

// ID | ID[] — for select inputs
createInput<ID | ID[]>({
  value: ref<ID[]>([]),
  dirty: v => Array.isArray(v) ? v.length > 0 : v != null,
})

Examples

API Reference

The following API details are for the createInput composable.

createInput

1 function, 13 options, 22 properties, 2 methods