@varlet/nuxt
v0.1.5
Published
varlet module for nuxt
Downloads
281
Readme
Varlet Nuxt
🌟 Inspired by vant-nuxt and element-plus-nuxt
Welcome to contribute this repo
Varlet Module for Nuxt3
Feature
- Auto import Varlet component in you Nuxt Project
- Auto import Varlet the directive
- Lazy load component
- Material Design Nuxt Component with Material 3 Version
Quick Setup
- Add
@varlet/nuxt
dependency to your project
npx nuxi@latest module add varlet
- Add
@varlet/nuxt
to themodules
section ofnuxt.config.ts
export default defineNuxtConfig({
modules: ['@varlet/nuxt'],
varlet: {
modulePath: '...',
exclude: ['...'],
icon: {}
}
})
That's it! You can now use Varlet Module in your Nuxt app ✨
tips: If you running varlet
on the PC. Please install @varlet/touch-emulator
Options
| fieldName | require | default | effect | | ---------- | ------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------- | | modulePath | false | undefind | customer you workspace path if you want | | exclude | false | '.nuxt', 'node_modules' | exclude some path that you won't transform | | icon | false | undefined | svg icon to iconfont |
Contribution
We recommend using pnpm
# Install dependencies
pnpm install
# Generate type stubs
pnpm run dev:prepare
# Develop with the playground
pnpm run dev
# Build the playground
pnpm run dev:build
# Run ESLint
pnpm run lint
# Release new version
pnpm run release