[Document] add form components english document (#199)

* [Document] add english document of Checkbox

* [Document] add english document of Field

* [Document] add english document of NumberKeyboard

* [bugfix] NumberKeyboard should not dispaly title when title is empty

* [Document] add english document of PasswordInput

* [Document] add english document of Radio

* [document] add english document of Switch

* [bugfix] remove redundent styles in english document

* [Document] fix details

* fix Switch test cases
This commit is contained in:
neverland
2017-10-12 07:06:27 -05:00
committed by GitHub
parent 47576ec47c
commit 9084a662c3
24 changed files with 858 additions and 293 deletions
+14 -37
View File
@@ -24,12 +24,6 @@ export default {
],
result: ['a', 'b']
};
},
watch: {
result(val) {
console.log(val);
}
}
};
</script>
@@ -38,9 +32,10 @@ export default {
### 使用指南
``` javascript
import { Checkbox } from 'vant';
import { Checkbox, CheckboxGroup } from 'vant';
Vue.component(Checkbox.name, Checkbox);
Vue.component(CheckboxGroup.name, CheckboxGroup);
```
### 代码演示
@@ -50,7 +45,7 @@ Vue.component(Checkbox.name, Checkbox);
:::demo 基础用法
```html
<van-checkbox v-model="checkbox1">复选框1</van-checkbox>
<van-checkbox v-model="checkbox1">复选框 1</van-checkbox>
```
```javascript
@@ -66,29 +61,17 @@ export default {
#### 禁用状态
设置`disabled`属性即可,此时`Checkbox`不能点击。
:::demo 禁用状态
```html
<van-checkbox v-model="checkbox2" disabled>复选框2</van-checkbox>
```
```javascript
export default {
data() {
return {
checkbox2: true
};
}
};
<van-checkbox v-model="checkbox2" disabled>复选框 2</van-checkbox>
```
:::
#### Checkbox组
#### Checkbox
需要与`van-checkbox-group`一起使用,通过`v-model`绑定在`van-checkbox-group`上,例如下面的`result`,此时`result`的值是一个数组。数组中的项即为选中的`Checkbox`的`name`属性设置的值
需要与`van-checkbox-group`一起使用,选中值是一个数组,通过`v-model`绑定在`van-checkbox-group`上,数组中的项即为选中的`Checkbox`的`name`属性设置的值
:::demo Checkbox组
:::demo Checkbox
```html
<van-checkbox-group v-model="result">
<van-checkbox
@@ -96,7 +79,7 @@ export default {
:key="index"
:name="item"
>
复选框{{ item }}
复选框 {{ item }}
</van-checkbox>
</van-checkbox-group>
```
@@ -108,20 +91,14 @@ export default {
list: ['a', 'b', 'c'],
result: ['a', 'b']
};
},
watch: {
result(val) {
console.log(val);
}
}
};
```
:::
#### 与Cell组件一起使用
#### 与 Cell 组件一起使用
此时你需要再引入`Cell`和`CellGroup`组件
此时你需要再引入`Cell`和`CellGroup`组件
:::demo 与Cell组件一起使用
```html
@@ -148,7 +125,7 @@ export default {
### Checkbox API
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------|
| name | 标识 Checkbox 名称 | `Boolean` | `false` | - |
| disabled | 是否禁用单选框 | `Boolean` | `false` | - |
@@ -156,18 +133,18 @@ export default {
### CheckboxGroup API
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|-----------|-----------|-----------|-------------|-------------|
| disabled | 是否禁用所有单选框 | `Boolean` | `false` | - |
### Checkbox Event
| 事件名称 | 说明 | 回调参数 |
| 事件名称 | 说明 | 回调参数 |
|-----------|-----------|-----------|
| change | 当绑定值变化时触发的事件 | 当前组件的值 |
### CheckboxGroup Event
| 事件名称 | 说明 | 回调参数 |
| 事件名称 | 说明 | 回调参数 |
|-----------|-----------|-----------|
| change | 当绑定值变化时触发的事件 | 当前组件的值 |