Nuxt

Adding the Nuxt module enables auto-imports for selected exports.

Run the following command in your Nuxt application:

npx nuxi module add regle

Or do it manually

pnpm

pnpm add @regle/core @regle/rules @regle/nuxt

npm

npm install @regle/core @regle/rules @regle/nuxt

yarn

yarn add @regle/core @regle/rules @regle/nuxt

bun

bun add @regle/core @regle/rules @regle/nuxt

You can then declare the module inside your nuxt.config.ts.

nuxt.config.ts

export default defineNuxtConfig({
  modules: ['@regle/nuxt']
})

setupFile

The Regle Nuxt module allow you to define a global configuration plugin to provide all your forms with the same translations, options and custom rules.

nuxt.config.ts

export default defineNuxtConfig({
  modules: ['@regle/nuxt'],
  regle: {
    setupFile: '~/regle-config.ts'
  }
})

app/regle-config.ts

import { defineRegleNuxtPlugin } from '@regle/nuxt/setup';
import { defineRegleConfig } from '@regle/core';
import { required, withMessage } from '@regle/rules';

export default defineRegleNuxtPlugin(() => {
  return defineRegleConfig({
    rules: () => {
      const {t} = useI18n();

      return {
        required: withMessage(required, t('general.required')),
        customRule: myCustomRule,
      }
    },
  });
});

This will inject the fellowing composables to your auto-imports and #imports, loaded with your custom error messages and rules:

• useRegle
• inferRules
• useCollectScope
• useScopedRegle
• type RegleFieldStatus

app.vue

<script setup lang="ts">
import { useRegle } from '#imports';
import { required, minLength, email } from '@regle/rules';

const { r$ } = useRegle({ name: '', email: '' }, {
  name: { required, minLength: minLength(4) },
  email: { email },
});

</script>

No options

If no setup file is provided, the following auto-imports will be added to your app.

• @regle/core

  • useRegle
  • inferRules
  • createRule
  • defineRegleConfig
  • extendRegleConfig
  • createVariant
  • narrowVariant
  • useScopedRegle
  • useCollectScope

• @regle/rules Note: Built-in rules are not auto-injected to minimize the risk of name conflicts.

  • withAsync
  • withMessage
  • withParams
  • withTooltip

• @regle/schemas (if present)

  • useRegleSchema
  • inferSchema
  • withDeps
  • defineRegleSchemaConfig