@formkit/addons

简介

FormKit的常见,可选,第一方附加功能。

您可以通过使用npm install @formkit/addonsyarn add @formkit/addons添加此包。

函数

createAutoAnimatePlugin()

自动为每个输入添加动画:

签名

createAutoAnimatePlugin(options?: AutoAnimateOptions, animationTargets?: Record<string, string[]>): FormKitPlugin;

参数

  • options 可选AutoAnimateOptions
  • animationTargets 可选 — 输入类型的映射和应该被动画化的它们的部分的数组。

返回

FormKitPlugin

示例

import { createApp } from 'vue'
import App from 'App.vue'
import { createAutoAnimatePlugin } from '@formkit/addons'
import { plugin, defaultConfig } from '@formkit/vue'

createApp(app).use(plugin, defaultPlugin({
  plugins: [
    createAutoAnimatePlugin({
      // 可选配置
      duration: 250,
      easing: 'ease-in-out',
      delay: 0,
    },
    {
      // 可选动画目标对象
      global: ['outer', 'inner'],
      form: ['form'],
      repeater: ['items'],
    })
  ]
}))

createAutoHeightTextareaPlugin()

创建一个新的自动高度文本区插件。

签名

createAutoHeightTextareaPlugin(): FormKitPlugin;

返回

一个 FormKitPlugin

createFloatingLabelsPlugin()

创建一个新的浮动标签插件。

签名

createFloatingLabelsPlugin(FloatingLabelsOptions?: FloatingLabelsOptions): FormKitPlugin;

参数

返回

一个 FormKitPlugin

createLocalStoragePlugin()

创建一个新的保存到本地存储插件。

签名

createLocalStoragePlugin(localStorageOptions?: LocalStorageOptions): FormKitPlugin;

参数

  • localStorageOptions 可选

返回

一个 FormKitPlugin

createMultiStepPlugin()

创建一个新的多步插件。

签名

createMultiStepPlugin(options?: MultiStepOptions): FormKitPlugin;

参数

返回

一个 FormKitPlugin

TypeScript

FloatingLabelsOptions

传递给 createFloatingLabelsPlugin 的选项

interface FloatingLabelsOptions {
    useAsDefault?: boolean;
}

LocalStorageOptions

传递给 createLocalStoragePlugin 的选项

interface LocalStorageOptions {
    beforeLoad?: (payload: any) => any;
    beforeSave?: (payload: any) => any;
    control?: string;
    debounce?: number;
    key?: string | number;
    maxAge?: number;
    prefix?: string;
}

MultiStepOptions

传递给 createMultiStepPlugin 的选项

interface MultiStepOptions {
    allowIncomplete?: boolean;
    hideProgressLabels?: boolean;
    tabStyle?:'tab' | 'progress';
}