docs(Form): add Field Type docs
This commit is contained in:
+153
-4
@@ -1,5 +1,9 @@
|
||||
# Form 表单
|
||||
|
||||
### 介绍
|
||||
|
||||
用于数据录入、校验,支持输入框、单选框、复选框、文件上传等类型
|
||||
|
||||
### 引入
|
||||
|
||||
```js
|
||||
@@ -13,6 +17,8 @@ Vue.use(Form);
|
||||
|
||||
### 基础用法
|
||||
|
||||
在表单中,每个 [Field](#/zh-CN/field) 代表一个表单项,使用 Field 的`rules`属性可以定义校验规则
|
||||
|
||||
```html
|
||||
<van-form @submit="onSubmit" @failed="onFailed">
|
||||
<van-field
|
||||
@@ -52,7 +58,147 @@ export default {
|
||||
console.log('failed', errorInfo);
|
||||
},
|
||||
},
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 开关
|
||||
|
||||
```html
|
||||
<van-field name="switch" label="开关">
|
||||
<van-switch v-model="switchChecked" slot="input" size="20" />
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
switchChecked: false,
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 复选框
|
||||
|
||||
```html
|
||||
<van-field name="checkbox" label="复选框">
|
||||
<van-checkbox v-model="checkbox" slot="input" shape="square" />
|
||||
</van-field>
|
||||
<van-field name="checkboxGroup" label="复选框组">
|
||||
<van-checkbox-group
|
||||
v-model="checkboxGroup"
|
||||
slot="input"
|
||||
direction="horizontal"
|
||||
>
|
||||
<van-checkbox name="1" shape="square">复选框 1</van-checkbox>
|
||||
<van-checkbox name="2" shape="square">复选框 2</van-checkbox>
|
||||
</van-checkbox-group>
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
checkbox: false,
|
||||
checkboxGroup: [],
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 单选框
|
||||
|
||||
```html
|
||||
<van-field name="radio" label="单选框">
|
||||
<van-radio-group v-model="radio" direction="horizontal" slot="input">
|
||||
<van-radio name="1">单选框 1</van-radio>
|
||||
<van-radio name="2">单选框 2</van-radio>
|
||||
</van-radio-group>
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
radio: '1',
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 步进器
|
||||
|
||||
```html
|
||||
<van-field name="stepper" label="步进器">
|
||||
<van-stepper v-model="stepper" slot="input" />
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
stepper: 1,
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 评分
|
||||
|
||||
```html
|
||||
<van-field name="rate" label="评分">
|
||||
<van-rate v-model="rate" slot="input" />
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
rate: 3,
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 滑块
|
||||
|
||||
```html
|
||||
<van-field name="slider" label="滑块">
|
||||
<van-slider v-model="slider" slot="input" />
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
slider: 50,
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### 表单项类型 - 文件上传
|
||||
|
||||
```html
|
||||
<van-field name="uploader" label="文件上传">
|
||||
<van-uploader v-model="uploader" slot="input" multiple max-count="2" />
|
||||
</van-field>
|
||||
```
|
||||
|
||||
```js
|
||||
export default {
|
||||
data() {
|
||||
return {
|
||||
uploader: [{ url: 'https://img.yzcdn.cn/vant/leaf.jpg' }],
|
||||
};
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## API
|
||||
@@ -60,14 +206,17 @@ export default {
|
||||
### Props
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|------|------|------|------|
|
||||
| ---- | ---- | ---- | ------ |
|
||||
|
||||
|
||||
### Events
|
||||
|
||||
| 事件名 | 说明 | 回调参数 |
|
||||
|------|------|------|
|
||||
| ------ | ---- | -------- |
|
||||
|
||||
|
||||
### Slots
|
||||
|
||||
| 名称 | 说明 |
|
||||
|------|------|
|
||||
| ---- | ---- |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user