vant/packages/vant/docs/markdown/quickstart.en-US.md

Quickstart

Install

npm

Using npm to install:

# install latest Vant for Vue 3 project
npm i vant

# install Vant 2 for Vue 2 project
npm i vant@latest-v2

Using yarn, pnpm, or bun:

# with yarn
yarn add vant

# with pnpm
pnpm add vant

# with Bun
bun add vant

Using in a New Project

If you need to create a new project, we recommend using Rsbuild, Vite or Nuxt framework.

Rsbuild

Rsbuild is a build tool based on Rspack, developed by the author of Vant, with first-class build speed and development experience, providing first-priority support for Vant.

You can create a Rsbuild project with the following command:

npm create rsbuild@latest

Please visit the Rsbuild repository for more information.

Example

Here are the example projects provided by Vant official. You can clone these projects and copy the code.

• vant-demo - rsbuild: Build an application using Vue 3, Vant 4, and Rsbuild.
• vant-demo - vite: Build an application using Vue 3, Vant 4, and Vite.
• vant-demo - nuxt3: Build an application using Vue 3, Nuxt 3, and Vant 4.

CDN

If you only need to develop a simple HTML page, you can directly include the CDN links in the HTML file. After that, you can access all the components through the global variable vant.

<!-- import style -->
<link
  rel="stylesheet"
  href="https://fastly.jsdelivr.net/npm/vant@4/lib/index.css"
/>

<!-- import script -->
<script src="https://fastly.jsdelivr.net/npm/vue@3"></script>
<script src="https://fastly.jsdelivr.net/npm/vant@4/lib/vant.min.js"></script>

<script>
  // Render the Button component
  const app = Vue.createApp({
    template: `<van-button>Button</van-button>`,
  });
  app.use(vant);

  // Register Lazyload directive
  app.use(vant.Lazyload);

  // Call function component
  vant.showToast('Message');

  app.mount('#app');
</script>

Free CDN

You can use Vant through these free CDN services:

• jsdelivr
• cdnjs
• unpkg

Note: Free CDN is generally used for making prototypes or personal projects. It is not recommended to use free CDN in production environment.

For enterprise developers, we recommend:

• install with npm, use build tools to bundle it
• download the scripts, host it on your own server

Usage

Basic Usage

The basic usage of Vant components:

import { createApp } from 'vue';
// 1. Import the components you need
import { Button } from 'vant';
// 2. Import the components style
import 'vant/lib/index.css';

const app = createApp();

// 3. Register the components you need
app.use(Button);

Tip: Vant supports Tree Shaking by default, so you don't need to configure any plugins, the unused JS code will be removed by Tree Shaking, but CSS styles cannot be optimized by it.

Import on demand

If you are using Rsbuild, Vite, webpack or vue-cli, you can use unplugin-vue-components, this plugin can help you to auto importing components.

Vant officially wrote an automatic import style parser @vant/auto-import-resolver based on unplugin-vue-components, both of which are used together.

Compared with conventional usage, this method can introduce the CSS style of components on demand, thus reducing part of the code volume, but it will become more cumbersome to use. If the business's volume requirements for CSS are not particularly extreme, we recommend a simpler general usage.

1. Install Plugin

# with npm
npm i @vant/auto-import-resolver unplugin-vue-components unplugin-auto-import -D

# with yarn
yarn add @vant/auto-import-resolver unplugin-vue-components unplugin-auto-import -D

# with pnpm
pnpm add @vant/auto-import-resolver unplugin-vue-components unplugin-auto-import -D

# with Bun
bun add @vant/auto-import-resolver unplugin-vue-components unplugin-auto-import -D

2. Configure Plugin

For Rsbuild based project，configure the plugin in the rsbuild.config.js file:

import { defineConfig } from '@rsbuild/core';
import { pluginVue } from '@rsbuild/plugin-vue';
import AutoImport from 'unplugin-auto-import/rspack';
import Components from 'unplugin-vue-components/rspack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';

export default defineConfig({
  plugins: [pluginVue()],
  tools: {
    rspack: {
      plugins: [
        AutoImport({
          imports: [VantImports()],
          resolvers: [VantResolver()],
        }),
        Components({
          resolvers: [VantResolver()],
        }),
      ],
    },
  },
});

For Vite based project，configure the plugin in the vite.config.js file:

import vue from '@vitejs/plugin-vue';
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';

export default {
  plugins: [
    vue(),
    AutoImport({
      imports: [VantImports()],
      resolvers: [VantResolver()],
    }),
    Components({
      resolvers: [VantResolver()],
    }),
  ],
};

For vue-cli based project，configure the plugin in the vue.config.js file:

const { VantResolver, VantImports } = require('@vant/auto-import-resolver');
const AutoImport = require('unplugin-auto-import/webpack');
const Components = require('unplugin-vue-components/webpack');

module.exports = {
  configureWebpack: {
    plugins: [
      // When the version of unplugin-vue-components is less than 0.26.0:
      AutoImport({ imports: [VantImports()], resolvers: [VantResolver()] }),
      Components({ resolvers: [VantResolver()] }),
      // when the unplugin-vue-components version is greater than or equal to 0.26.0:
      AutoImport.default({
        imports: [VantImports()],
        resolvers: [VantResolver()],
      }),
      Components.default({ resolvers: [VantResolver()] }),
    ],
  },
};

For webpack based project，configure the plugin in the webpack.config.js file:

const { VantResolver, VantImports } = require('@vant/auto-import-resolver');
const AutoImport = require('unplugin-auto-import/webpack');
const Components = require('unplugin-vue-components/webpack');

module.exports = {
  plugins: [
    // When the version of unplugin-vue-components is less than 0.26.0:
    AutoImport({ imports: [VantImports()], resolvers: [VantResolver()] }),
    Components({ resolvers: [VantResolver()] }),
    // when the unplugin-vue-components version is greater than or equal to 0.26.0:
    AutoImport.default({
      imports: [VantImports()],
      resolvers: [VantResolver()],
    }),
    Components.default({ resolvers: [VantResolver()] }),
  ],
};

3. Using Components

Then you can using components from Vant in the template, the unplugin-vue-components will automatically import the corresponding Vant components,@vant/auto-import-resolver The corresponding component style will be automatically introduced.

<template>
  <van-button type="primary" />
</template>

unplugin-auto-import will automatically import the corresponding Vant API and styles.

<script>
  showToast('No need to import showToast');
</script>

Tips

• "Full Import" and "On-demand Import" should not be used at the same time, otherwise it will lead to problems such as code duplication and style overrides.
• During use, if the component cannot be imported, because unplugin-vue-components is not a plug-in officially maintained by Vant, it is recommended to give feedback under the unplugin/unplugin-vue-components repository.
• when the version number of unplugin-vue-components is >= 0.26.0, for webpack, vue-cli, and rspack, you need to use ComponentsPlugin.default to register.
• @vant/auto-import-resolver provides some configuration options. Please refer to the README document for more information.
• If it is a similar problem that the style does not take effect, feedback under the Vant repository.

With Frameworks

Use Vant in Nuxt 3

When using Vant in Nuxt 3, you can use vant-nuxt, this module can help you to auto importing components and reduce CSS file size.

1. Install Module

# with npm
npm i @vant/nuxt -D

# with yarn
yarn add @vant/nuxt -D

# with pnpm
pnpm add @vant/nuxt -D

# with Bun
bun add @vant/nuxt -D

2. Add Module

add the module in the nuxt.config.js file:

export default defineNuxtConfig({
  modules: ['@vant/nuxt'],
});

3. Using Components

Then you can using components from Vant in the template, Go to the Nuxt documentation to learn more.

<template>
  <van-button type="primary" @click="showToast('toast')">button</van-button>
  <VanButton type="success" @click="showNotify('notify')">button</VanButton>
  <LazyVanButton type="default">lazy button</LazyVanButton>
</template>