mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
152 lines
2.9 KiB
Markdown
152 lines
2.9 KiB
Markdown
# Quickstart
|
||
|
||
### Starter kit
|
||
|
||
We recomment to use [Vue Cli](https://cli.vuejs.org/zh/) to create a project.
|
||
|
||
```bash
|
||
# Install Vue Cli
|
||
npm install -g @vue/cli
|
||
|
||
# Create a project
|
||
vue create hello-world
|
||
|
||
# Open GUI
|
||
vue ui
|
||
```
|
||
|
||
|
||
|
||
In the GUI, click on 'Dependencies' -> `Install Dependencies` and add `vant` to the dependencies.
|
||
|
||
### Install
|
||
|
||
```bash
|
||
# Using npm
|
||
npm i vant -S
|
||
|
||
# Using yarn
|
||
yarn add vant
|
||
```
|
||
|
||
> Tips: Please install Vant 3.0 for Vue 3 projects, see [issue#7035](https://github.com/youzan/vant/issues/7035)
|
||
|
||
## Usage
|
||
|
||
### 1. Import on demand
|
||
|
||
Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) to import components on demand
|
||
|
||
```bash
|
||
# Install plugin
|
||
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
|
||
}]
|
||
]
|
||
}
|
||
|
||
// For users who use babel7, that can be configured in babel.config.js
|
||
module.exports = {
|
||
plugins: [
|
||
['import', {
|
||
libraryName: 'vant',
|
||
libraryDirectory: 'es',
|
||
style: true
|
||
}, 'vant']
|
||
]
|
||
};
|
||
```
|
||
|
||
```js
|
||
// Then you can import components from vant
|
||
import { Button } from 'vant';
|
||
```
|
||
|
||
> If you are using TypeScript，please use [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) instead
|
||
|
||
### 2. Manually import
|
||
|
||
```js
|
||
import Button from 'vant/lib/button';
|
||
import 'vant/lib/button/style';
|
||
```
|
||
|
||
### 3. Import all components
|
||
|
||
```js
|
||
import Vue from 'vue';
|
||
import Vant from 'vant';
|
||
import 'vant/lib/index.css';
|
||
|
||
Vue.use(Vant);
|
||
```
|
||
|
||
> If you configured babel-plugin-import, you won't be allowed to import all components.
|
||
|
||
### 4. CDN
|
||
|
||
The easiest way to use Vant is to include a CDN link in the html file, after which you can access all components via the global variable `vant`.
|
||
|
||
```html
|
||
<!-- import style -->
|
||
<link
|
||
rel="stylesheet"
|
||
href="https://cdn.jsdelivr.net/npm/vant@2.9/lib/index.css"
|
||
/>
|
||
|
||
<!-- import script -->
|
||
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></script>
|
||
<script src="https://cdn.jsdelivr.net/npm/vant@2.9/lib/vant.min.js"></script>
|
||
|
||
<script>
|
||
// Render the Button component
|
||
new Vue({
|
||
el: '#app',
|
||
template: `<van-button>Button</van-button>`,
|
||
});
|
||
|
||
// Call function component
|
||
vant.Toast('Message');
|
||
|
||
// Register Lazyload directive
|
||
Vue.use(vant.Lazyload);
|
||
</script>
|
||
```
|
||
|
||
## Other
|
||
|
||
### 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
|
||
|
||
postcss config example:
|
||
|
||
```js
|
||
module.exports = {
|
||
plugins: {
|
||
autoprefixer: {
|
||
browsers: ['Android >= 4.0', 'iOS >= 8'],
|
||
},
|
||
'postcss-pxtorem': {
|
||
rootValue: 37.5,
|
||
propList: ['*'],
|
||
},
|
||
},
|
||
};
|
||
```
|