Installation

NotForm is distributed as an npm package and can be used directly in any Vue 3 application.

If you are using Nuxt, we recommend using the official Nuxt Module instead. The Nuxt integration handles the framework-specific setup for you and provides a zero-config experience.

Install the package

Install NotForm using your preferred package manager.

NotForm uses Standard Schema for validation, so you will also need a compatible validation library. Popular options include Zod, Valibot, and ArkType.

Choose the validation library you want to use and install it alongside NotForm.

pnpm add notform zod

yarn add notform zod

npm install notform zod

bun add notform zod

Vue and Vite

NotForm is designed for Vue 3 and works with standard Vue applications without requiring a special build step or application-level configuration.

Once installed, you can import the components, composables, and utilities you need directly from notform:

<script setup lang="ts">
import { NotField, NotForm, NotMessage } from 'notform'
</script>

<template>
  <NotForm>
    <!-- form fields -->
  </NotForm>
</template>

NotForm follows the normal Vue component model, so there is no global registration step required. Import only the pieces you use in your application.

The exact form structure and available components are covered in the Quickstart.

Nuxt

For Nuxt applications, use the Nuxt Module rather than manually configuring NotForm.

The module integrates NotForm with Nuxt and takes care of the framework-specific setup, allowing you to start using NotForm without adding that configuration yourself.

Next steps

NotForm is now ready to use in your project.

Continue to the Quickstart to create your first form and learn how NotForm's components, fields, validation, and Standard Schema integration work together.