Lightweight Mobile UI Components built on Vue
[](https://travis-ci.org/youzan/vant) [](https://www.npmjs.com/package/vant) [](https://codecov.io/github/youzan/vant?branch=dev) [](https://www.npmjs.com/package/vant) [](https://www.npmjs.com/package/vant) [](https://unpkg.com/vant/lib/vant.min.js) [](https://unpkg.com/vant/lib/vant-css/index.css) ## 特性 * 50+ 个经过有赞线上业务检验的组件 * 单元测试覆盖率超过 90% * 完善的中英文文档和示例 * 支持 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) * 支持 TypeScript * 支持 SSR ## 安装 #### NPM ```shell npm i vant -S ``` #### YARN ```shell yarn add vant ``` #### CDN 访问下面的文件 URL，会自动重定向至最新版本的 CDN 链接，建议使用固定版本的 CDN 链接，避免升级时受到非兼容性更新的影响。 ```html ``` ## 快速上手 #### 方式一. 使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (推荐) `babel-plugin-import` 是一款 babel 插件，它会在编译过程中将 import 的写法自动转换为按需引入的方式 ```bash # 安装 babel-plugin-import 插件 npm i babel-plugin-import -D ``` ```js // 在 .babelrc 或 babel-loader 中添加插件配置 // 注意：webpack 1 无需设置 libraryDirectory。 { "plugins": [ ["import", { "libraryName": "vant", "libraryDirectory": "es", "style": true }] ] } ``` 接着你可以在代码中直接引入 Vant 组件，插件会自动将代码转化为方式二中的按需引入形式。 ```js import { Button } from 'vant'; ``` > 如果你在使用 TypeScript，可以使用 [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) 实现按需引入 #### 方式二. 按需引入组件 在不使用插件的情况下，可以手动引入需要的组件 ```js import Button from 'vant/lib/button'; import 'vant/lib/vant-css/base.css'; import 'vant/lib/vant-css/button.css'; ``` #### 方式三. 导入所有组件 ```js import Vue from 'vue'; import Vant from 'vant'; import 'vant/lib/vant-css/index.css'; Vue.use(Vant); ``` > 注意：配置 babel-plugin-import 插件后将不允许导入所有组件 更多内容请参考 [快速上手](https://youzan.github.io/vant#/zh-CN/quickstart). ## 贡献代码 修改代码请阅读我们的 [开发指南](./.github/CONTRIBUTING.zh-CN.md)。 使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。 ## 浏览器支持 现代浏览器以及 Android 4.0+, iOS 6+. ## 链接 * [详细文档](https://youzan.github.io/vant) * [更新日志](https://youzan.github.io/vant#/zh-CN/changelog) * [React 组件库](https://www.youzanyun.com/zanui/zent) * [微信小程序组件库](https://github.com/youzan/zanui-weapp) * [vant-demo](https://github.com/youzan/vant-demo) * [vue-cli-template-vant](https://github.com/youzan/vue-cli-template-vant) ## 手机预览 可以手机扫码以下二维码访问手机端 demo：
## 微信讨论群
欢迎大家加入 Vant 交流群一起讨论，添加下方微信并注明『加入 Vant 交流群』即可
## 开源协议
本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源。