The official FormKit/Vue integration. This package is responsible for integrating Vue with FormKit core and other first-party packages.
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.
createInput(schemaOrComponent: FormKitSchemaNode | FormKitSection | Component, definitionOptions?: Partial<FormKitTypeDefinition>): FormKitTypeDefinition;
schemaOrComponent
— The actual schema of the input or the component.definitionOptions
— Any options in the FormKitTypeDefinition you want to define.A composable for creating a new FormKit node.
useInput(props: FormKitComponentProps, context: SetupContext<any>, options?: FormKitOptions): FormKitNode;
props
context
options
A special watcher for Vue that reports the location of a deep mutation.
watchVerbose<T extends Ref<unknown> | Record<string, any>>(obj: T, callback: (keypath: string[], value?: unknown, obj?: T) => void): void;
obj
— An object to observe at depth.callback
— A callback to call when a change is detected.The global instance of the FormKit plugin.
interface FormKitVuePlugin { clearErrors: (formId: string) => void get: (id: string) => FormKitNode | undefined reset: (formId: string, resetTo?: unknown) => void setErrors: ( formId: string, errors: string[] | Record<string, string | string[]>, inputErrors?: string[] | Record<string, string | string[]> ) => void setLocale: (locale: string) => void submit: (formId: string) => void}
The allowed options for defaultConfig.
type DefaultConfigOptions = FormKitOptions & Partial<PluginConfigs> & Record<string, unknown>