# 🧾 Nuxt Auto Form

[![npm version][npm-version-src]][npm-version-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

Auto-generate Nuxt UI forms from Zod 4 schemas

> [!WARNING]
> This module is in **beta**.
> All ideas/suggestions/bug reports are welcome!

- [✨  Release Notes](/CHANGELOG.md)
- [📖  Documentation](https://nuxt-auto-form.norbiros.dev)
- [👾  Playground](https://stackblitz.com/github/Norbiros/nuxt-auto-form/tree/master/playground?file=app%2Fcomponents%2FMyForm.vue)

## Features

* ❤️ **Powered by Zod & Nuxt UI**: Reduce your boilerplate in seconds, without complex rewrites.
* 📋 **Schema-Driven Forms**: Automatically generates forms based on Zod schemas, ensuring type safety and validation.
* 🎨 **Good Looking**: Leverages Nuxt UI components for a consistent and modern design.
* 🔄 **Dynamic Field Rendering**: Supports various field types, including text inputs, selects, checkboxes, and more.
* ⚙️ **Customizable**: Easily customize any button, field, and input.

## Quick Setup

Install the module to your Nuxt application with one command:

```bash
npx nuxi module add @norbiros/nuxt-auto-form
```

That's it! You can now use Nuxt Auto Form in your Nuxt app ✨

## Contribution

```bash
# Install dependencies
pnpm install

# Generate type stubs
pnpm dev:prepare

# Develop with the playground
pnpm dev

# Develop documentation
pnpm docs:dev

# Run ESLint
pnpm lint
pnpm lint:fix

# Run e2e tests
pnpm e2e

# Release new version
pnpm run release
```

## License

Made with 💚

Published under the [MIT License](./LICENCE).

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@norbiros/nuxt-auto-form/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@norbiros/nuxt-auto-form

[license-src]: https://img.shields.io/npm/l/@norbiros/nuxt-auto-form.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@norbiros/nuxt-auto-form

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com