@formkit/vue

Introduction

The official FormKit/Vue integration. This package is responsible for integrating Vue with FormKit core and other first-party packages.

Functions

createInput()

Creates a new input from schema or a Vue component with the "standard" FormKit features in place such as labels, help text, validation messages, and class support.

Signature

Parameters

  • schemaOrComponent — The actual schema of the input or the component.
  • definitionOptions — Any options in the FormKitTypeDefinition you want to define.

Returns

FormKitTypeDefinition

useInput()

A composable for creating a new FormKit node.

Signature

Parameters

  • props
  • context
  • options

Returns

FormKitNode

watchVerbose()

A special watcher for Vue that reports the location of a deep mutation.

Signature

Parameters

  • obj — An object to observe at depth.
  • callback — A callback to call when a change is detected.

TypeScript

FormKitVuePlugin

The global instance of the FormKit plugin.

DefaultConfigOptions

The allowed options for defaultConfig.