@vee-validate/nuxt

公式vee-validate Nuxtモジュール

公式vee-validateのNuxtモジュール

機能

vee-validateコンポーネントの自動インポート
vee-validateコンポーザブルの自動インポート
zodまたはyupを使用しているかどうかを検出し、どちらにも適したtoTypedSchemaを公開します。

はじめに

Nuxtプロジェクトでvee-validate Nuxtモジュールをインストールします。

# npm
npm i @vee-validate/nuxt

# pnpm
pnpm add @vee-validate/nuxt

# yarn
yarn add @vee-validate/nuxt

次に、nuxt.config.tsのmodules設定にモジュールを追加します。

export default defineNuxtConfig({
  // ...
  modules: [
    //...
    '@vee-validate/nuxt',
  ],
});

型

vee-validateの主要なAPIコンポーネント/コンポーザブルを除き、他のライブラリとの競合を避けるため、デフォルトでは型は公開されません。vee-validate経由でインポートすることは可能です。

設定

@vee-validate/nuxtモジュールのいくつかの側面を設定できます。こちらが設定インターフェースです。

export default defineNuxtConfig({
  // ...
  modules: [
    //...
    [
      '@vee-validate/nuxt',
      {
        // disable or enable auto imports
        autoImports: true,
        // Use different names for components
        componentNames: {
          Form: 'VeeForm',
          Field: 'VeeField',
          FieldArray: 'VeeFieldArray',
          ErrorMessage: 'VeeErrorMessage',
        },
      },
    ],
  ],
});

配列構文の代わりにveeValidate設定キーを使用することもできます。

export default defineNuxtConfig({
  // ...
  modules: [
    //...
    '@vee-validate/nuxt',
  ],
  veeValidate: {
    // disable or enable auto imports
    autoImports: true,
    // Use different names for components
    componentNames: {
      Form: 'VeeForm',
      Field: 'VeeField',
      FieldArray: 'VeeFieldArray',
      ErrorMessage: 'VeeErrorMessage',
    },
  },
});