[Improvement] Reorganize document (#1066)

2025-12-24 02:02:09 +08:00 · 2018-05-15 10:39:01 +08:00
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
--- a/packages/checkbox/en-US.md
+++ b/packages/checkbox/en-US.md
@@ -0,0 +1,120 @@
+## Checkbox
+
+### Install
+``` javascript
+import { Checkbox, CheckboxGroup } from 'vant';
+
+Vue.use(Checkbox).use(CheckboxGroup);
+```
+
+### Usage
+
+#### Basic Usage
+
+```html
+<van-checkbox v-model="checked">Checkbox</van-checkbox>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      checked: true
+    };
+  }
+};
+```
+
+#### Disabled
+
+```html
+<van-checkbox v-model="checked" disabled>Checkbox</van-checkbox>
+```
+
+#### Disable Label click event
+
+```html
+<van-checkbox v-model="checked" label-disabled>Checkbox</van-checkbox>
+```
+
+#### Checkbox Group
+When Checkboxes are inside a CheckboxGroup, the checked checkboxes's name is an array and bound with CheckboxGroup by v-model.
+
+```html
+<van-checkbox-group v-model="result">
+  <van-checkbox
+    v-for="(item, index) in list"
+    :key="item"
+    :name="item"
+  >
+    Checkbox {{ item }}
+  </van-checkbox>
+</van-checkbox-group>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      list: ['a', 'b', 'c'],
+      result: ['a', 'b']
+    };
+  }
+};
+```
+
+#### Maximum amount of checked options
+
+```html
+<van-checkbox-group v-model="result" :max="2">
+  <van-checkbox
+    v-for="(item, index) in list"
+    :name="item"
+    :key="item"
+  >
+    Checkbox {{ item }}
+  </van-checkbox>
+</van-checkbox-group>
+```
+
+#### Inside a Cell
+
+```html
+<van-checkbox-group v-model="result">
+  <van-cell-group>
+    <van-cell v-for="item in list" :title="`Checkbox ${item}`" :key="item">
+      <van-checkbox :name="item" />
+    </van-cell>
+  </van-cell-group>
+</van-checkbox-group>
+```
+
+### Checkbox API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| v-model | Check status | `Boolean` | `false` |
+| name | Checkbox name | `any` | - |
+| disabled | Diable checkbox | `Boolean` | `false` |
+| label-disabled | Whether to disable label click | `Boolean` | `false` |
+| shape | Can be set to `round` `square` | `String` | `round` |
+
+### CheckboxGroup API
+
+| Attribute | Description | Type | Default |
+|-----------|-----------|-----------|-------------|
+| v-model | Names of all checked checkboxes | `Array` | - |
+| disabled | Disable all checkboxes | `Boolean` | `false` |
+| max | Maximum amount of checked options | `Number` | `0`(Unlimited) |
+
+### Checkbox Event
+
+| Event | Description | Parameters |
+|-----------|-----------|-----------|
+| change | Triggered when value changed | current value |
+
+### CheckboxGroup Event
+
+| Event | Description | Parameters |
+|-----------|-----------|-----------|
+| change | Triggered when value changed | current value |
--- a/packages/checkbox/zh-CN.md
+++ b/packages/checkbox/zh-CN.md
@@ -0,0 +1,124 @@
+## Checkbox 复选框
+
+### 使用指南
+``` javascript
+import { Checkbox, CheckboxGroup } from 'vant';
+
+Vue.use(Checkbox).use(CheckboxGroup);
+```
+
+### 代码演示
+
+#### 基础用法
+通过`v-model`绑定 checkbox 的勾选状态
+
+```html
+<van-checkbox v-model="checked">复选框</van-checkbox>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      checked: true
+    };
+  }
+};
+```
+
+#### 禁用状态
+
+```html
+<van-checkbox v-model="checked" disabled>复选框</van-checkbox>
+```
+
+#### 禁用内容部分点击事件
+
+```html
+<van-checkbox v-model="checked" label-disabled>复选框</van-checkbox>
+```
+
+#### Checkbox 组
+
+需要与`van-checkbox-group`一起使用，选中值是一个数组，通过`v-model`绑定在`van-checkbox-group`上，数组中的项即为选中的`Checkbox`的`name`属性设置的值
+
+```html
+<van-checkbox-group v-model="result">
+  <van-checkbox
+    v-for="(item, index) in list"
+    :key="item"
+    :name="item"
+  >
+    复选框 {{ item }}
+  </van-checkbox>
+</van-checkbox-group>
+```
+
+```javascript
+export default {
+  data() {
+    return {
+      list: ['a', 'b', 'c'],
+      result: ['a', 'b']
+    };
+  }
+};
+```
+
+#### 设置最大可选数
+
+```html
+<van-checkbox-group v-model="result" :max="2">
+  <van-checkbox
+    v-for="(item, index) in list"
+    :key="item"
+    :name="item"
+  >
+    复选框 {{ item }}
+  </van-checkbox>
+</van-checkbox-group>
+```
+
+#### 与 Cell 组件一起使用
+
+此时你需要再引入`Cell`和`CellGroup`组件
+
+```html
+<van-checkbox-group v-model="result">
+  <van-cell-group>
+    <van-cell v-for="item in list" :title="`复选框 ${item}`" :key="item">
+      <van-checkbox :name="item" />
+    </van-cell>
+  </van-cell-group>
+</van-checkbox-group>
+```
+
+### Checkbox API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| v-model | 是否为选中状态 | `Boolean` | `false` |
+| name | 标识 Checkbox 名称 | `any` | - |
+| disabled | 是否禁用单选框 | `Boolean` | `false` |
+| label-disabled | 是否禁用单选框内容点击 | `Boolean` | `false` |
+| shape | 形状，可选值为 `round` `square` | `String` | `round` |
+
+### CheckboxGroup API
+
+| 参数 | 说明 | 类型 | 默认值 |
+|-----------|-----------|-----------|-------------|
+| v-model | 所有选中项的 name | `Array` | - |
+| disabled | 是否禁用所有单选框 | `Boolean` | `false` |
+| max | 设置最大可选数 | `Number` | `0`（无限制） |
+
+### Checkbox Event
+
+| 事件名称 | 说明 | 回调参数 |
+|-----------|-----------|-----------|
+| change | 当绑定值变化时触发的事件 | 当前组件的值 |
+
+### CheckboxGroup Event
+
+| 事件名称 | 说明 | 回调参数 |
+|-----------|-----------|-----------|
+| change | 当绑定值变化时触发的事件 | 当前组件的值 |