@ipeeon/nuxt
v1.0.0
Published
Nuxt 3 module for Haspen UI
Readme
@haspen/nuxt
Nuxt 3 module for HäspenUI design system.
Installation
# Using pnpm
pnpm add -D @haspen/nuxt
# Using npm
npm install -D @haspen/nuxt
# Using yarn
yarn add -D @haspen/nuxtUsage
Add @haspen/nuxt to your Nuxt modules in nuxt.config.ts:
export default defineNuxtConfig({
modules: ['@haspen/nuxt'],
haspen: {
// Module options
components: true, // Auto-import components
composables: true, // Auto-import composables
prefix: 'Haspen', // Component name prefix
},
});Features
- 🎨 Automatic component registration
- 🔄 Composable auto-imports
- ⚙️ Configurable options
- 🎯 TypeScript support
Configuration
| Option | Type | Default | Description |
| ------------- | --------- | ---------- | ------------------------------------------- |
| components | boolean | true | Whether to automatically import components |
| composables | boolean | true | Whether to automatically import composables |
| prefix | string | 'Haspen' | Prefix for component names |
TypeScript-konfiguration
Denne pakke bruger en specifik tsconfig.json, som udvider rodens tsconfig.build.json.
Konfigurationen er tilpasset til Nuxt 3 moduler:
- outDir:
dist - rootDir:
src - Types genereres automatisk ved build
- module:
NodeNext - moduleResolution:
NodeNext
Dette sikrer korrekt typesætning og kompatibilitet med Nuxt 3 modul-systemet.
Byg pakken med:
pnpm buildLicense
MIT
My Module
My new Nuxt module for doing amazing things.
Features
- ⛰ Foo
- 🚠 Bar
- 🌲 Baz
Quick Setup
Install the module to your Nuxt application with one command:
npx nuxi module add my-moduleThat's it! You can now use My Module in your Nuxt app ✨
Contribution
# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Run Vitest
npm run test
npm run test:watch
# Release new version
npm run release