mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
107 lines
1.9 KiB
Markdown
107 lines
1.9 KiB
Markdown
## Quickstart
|
||
|
||
### Starter kit
|
||
|
||
Use [vue-cli](https://github.com/vuejs/vue-cli) to create a vant project.
|
||
|
||
```shell
|
||
vue init youzan/vue-cli-template-vant projectName
|
||
```
|
||
|
||
### Install
|
||
|
||
#### NPM
|
||
|
||
```shell
|
||
npm i vant -S
|
||
```
|
||
|
||
#### YARN
|
||
|
||
```shell
|
||
yarn add vant
|
||
```
|
||
|
||
#### CDN
|
||
|
||
```html
|
||
<!-- import style -->
|
||
<link rel="stylesheet" href="https://unpkg.com/vant/lib/vant-css/index.css" />
|
||
|
||
<!-- import script -->
|
||
<script src="https://unpkg.com/vue/dist/vue.min.js"></script>
|
||
<script src="https://unpkg.com/vant/lib/vant.min.js"></script>
|
||
```
|
||
|
||
### Usage
|
||
|
||
#### 1. Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (Recommended)
|
||
|
||
```bash
|
||
# Install babel-plugin-import
|
||
npm i babel-plugin-import -D
|
||
```
|
||
|
||
```js
|
||
// set babel config in .babelrc or babel-loader
|
||
// Note: Don't set libraryDirectory if you are using webpack 1.
|
||
{
|
||
"plugins": [
|
||
["import", {
|
||
"libraryName": "vant",
|
||
"libraryDirectory": "es",
|
||
"style": true
|
||
}]
|
||
]
|
||
}
|
||
```
|
||
|
||
Then you can import components from vant, equivalent to import manually below.
|
||
|
||
```js
|
||
import { Button } from 'vant';
|
||
```
|
||
|
||
#### 2. Manually import
|
||
|
||
```js
|
||
import Button from 'vant/lib/button';
|
||
import 'vant/lib/vant-css/base.css';
|
||
import 'vant/lib/vant-css/button.css';
|
||
```
|
||
|
||
#### 3. Import all components
|
||
|
||
```js
|
||
import Vue from 'vue';
|
||
import Vant from 'vant';
|
||
import 'vant/lib/vant-css/index.css';
|
||
|
||
Vue.use(Vant);
|
||
```
|
||
|
||
> If you configured babel-plugin-import, you won't be allowed to import all components.
|
||
|
||
|
||
### Rem units
|
||
|
||
Vant use `px` as size units by default，you can use tools such as `postcss-pxtorem` to transform units to `rem`.
|
||
|
||
- [postcss-pxtorem](https://github.com/cuth/postcss-pxtorem)
|
||
- [lib-flexible](https://github.com/amfe/lib-flexible)
|
||
|
||
postcss config example:
|
||
|
||
```js
|
||
module.exports = {
|
||
plugins: {
|
||
'autoprefixer': {
|
||
browsers: ['Android >= 4.0', 'iOS >= 7']
|
||
}
|
||
'postcss-pxtorem': {
|
||
rootValue: 37.5,
|
||
propList: ['*']
|
||
}
|
||
}
|
||
}
|
||
``` |