https://github.com/vant-ui/vant-nuxt
Vant module for Nuxt
https://github.com/vant-ui/vant-nuxt
nuxt vant vant-ui
Last synced: 10 months ago
JSON representation
Vant module for Nuxt
- Host: GitHub
- URL: https://github.com/vant-ui/vant-nuxt
- Owner: vant-ui
- License: mit
- Created: 2023-02-12T01:48:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-29T05:50:49.000Z (about 1 year ago)
- Last Synced: 2025-08-02T15:12:22.228Z (10 months ago)
- Topics: nuxt, vant, vant-ui
- Language: TypeScript
- Homepage:
- Size: 340 KB
- Stars: 93
- Watchers: 3
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vant Nuxt
Vant module for Nuxt
## Features
- Automatically import components and styles on demand.
- Automatically import of showDialog, showToast and other methods.
## Install
```shell
npx nuxi@latest module add vant
# or
npm i vant @vant/nuxt -D
```
```ts
export default defineNuxtConfig({
modules: ['@vant/nuxt'],
vant: {
/** Options */
},
});
```
## Usage
```vue
button
button
lazy button
```
Reference [Nuxt documentation](https://nuxt.com/docs/guide/directory-structure/components) and [playground](./playground/app.vue) use.
## Options
### lazyload
- Type: `boolean` | `object`
- Default: `false`
How to load directives and components from lazyload.
eg. `{ lazyComponent: true }`
### importStyle
- Type: `boolean`
- Default: `true`
Whether to automatically import styles.
### defaultLocale
- Type: `string`
Replace default locale, you can find locale list [here](https://github.com/youzan/vant/tree/main/packages/vant/src/locale/lang).
### excludeExports
- Type: `array`
- Default: `['Lazyload', 'Locale']`
Exclude exports from Vant that are not component content.
### components
- Type: `array`
If there are components that are not imported automatically from Vant, you need to add the component here.
### imports
- Type: `array`
If you wish to add automatically import content from Vant, you can add it here.
### include
- Type: `array`
- Default: `[ /\.vue$/, /\.vue\?vue/, /\.vue\?v=/, /\.((c|m)?j|t)sx?$/]`
Include files that need to automatically import styles.
### exclude
- Type: `array`
- Default: `[/[\\/]node_modules[\\/]/, /[\\/]\.git[\\/]/, /[\\/]\.nuxt[\\/]/]`
Exclude files that do not require the automatic import of styles.
## Development
- Run `pnpm i` to install the dependencies.
- Run `pnpm dev:prepare` to generate type stubs.
- Run `pnpm dev` to start playground in development mode.
- Run `pnpm dev:build` to build playground.
- Run `pnpm dev:start` to locally preview playground.
- Run `pnpm build` to build this project.