Skip to content

Installation

Quick Install

The easiest way to add nuxt-freeform to your Nuxt project:

bash
npx nuxi module add nuxt-freeform

Manual Installation

1. Install the package

bash
pnpm add nuxt-freeform

2. Add to nuxt.config.ts

ts
export default defineNuxtConfig({
  modules: ['nuxt-freeform']
})

That's it! All components are auto-imported and ready to use.

What's Included

After installation, these components are available globally:

ComponentDescription
TheFreeformMain container that manages drag & drop state
FreeformItemIndividual draggable item
FreeformPlaceholderShows where items will land
FreeformSelectionEnables lasso selection

Requirements

  • Nuxt 3.0+ (Nuxt 4 compatible)
  • Vue 3.5+
  • Node.js 18+

Next Steps

Head to Quick Start to build your first drag & drop interface.

MIT Licensed