@formkit/addons

Introduction

Des fonctionnalités supplémentaires communes, optionnelles et de première partie pour FormKit.

Vous pouvez ajouter ce package en utilisant npm install @formkit/addons ou yarn add @formkit/addons.

Fonctions

createAutoAnimatePlugin()

Ajoute auto-animate à chaque entrée automatiquement :

Signature

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

Paramètres

  • options optionnel — AutoAnimateOptions
  • animationTargets optionnel — Une carte des types d'entrée et un tableau de leurs sections qui devraient être animées.

Retourne

FormKitPlugin

Exemples

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({
      // config optionnelle
      duration: 250,
      easing: 'ease-in-out',
      delay: 0,
    },
    {
      // objet cibles d'animation optionnel
      global: ['outer', 'inner'],
      form: ['form'],
      repeater: ['items'],
    })
  ]
}))

createAutoHeightTextareaPlugin()

Crée un nouveau plugin de zone de texte à hauteur automatique.

Signature

createAutoHeightTextareaPlugin(): FormKitPlugin;

Retourne

Un FormKitPlugin

createFloatingLabelsPlugin()

Crée un nouveau plugin d'étiquettes flottantes.

Signature

createFloatingLabelsPlugin(FloatingLabelsOptions?: FloatingLabelsOptions): FormKitPlugin;

Paramètres

Retourne

Un FormKitPlugin

createLocalStoragePlugin()

Crée un nouveau plugin de sauvegarde en local.

Signature

createLocalStoragePlugin(localStorageOptions?: LocalStorageOptions): FormKitPlugin;

Paramètres

  • localStorageOptions optionnel

Retourne

Un FormKitPlugin

createMultiStepPlugin()

Crée un nouveau plugin multi-étapes.

Signature

createMultiStepPlugin(options?: MultiStepOptions): FormKitPlugin;

Paramètres

Retourne

Un FormKitPlugin

TypeScript

FloatingLabelsOptions

Les options à passer à createFloatingLabelsPlugin

interface FloatingLabelsOptions {
    useAsDefault?: boolean;
}

LocalStorageOptions

Les options à passer à createLocalStoragePlugin

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

MultiStepOptions

Les options à passer à createMultiStepPlugin

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