Skip to content

Commit d102a1b

Browse files
huangshuweihuangshuwei
committed
add doc
1 parent 3ad0156 commit d102a1b

File tree

6 files changed

+112
-36
lines changed

6 files changed

+112
-36
lines changed

‎examples/src/docs/en/ve-dropdown/api.md‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,25 @@
22

33
### props
44

5-
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
6-
| ----------------- | ----------------------------------------- | --------- | ------ | ------ |
7-
| isSelect | 是否供 select 组件使用 | `Boolean` | - | false |
8-
| showOperation | 展示操作按钮 | `Boolean` | - | false |
9-
| width | 下拉组件最小宽度 | `Number` | - | 90 |
10-
| maxWidth | 下拉组件最大宽度 | `Number` | - | 1000 |
11-
| isMultiple | 是否是多选下拉 | `Boolean` | - | false |
12-
| value | v-model 输入值 | `Array` | - | - |
13-
| textAlign | 下拉项居中方式 | `String` | - | "left" |
14-
| isInput | 是否包含 input | `Boolean` | - | false |
15-
| confirmFilterText | 确认按钮文本 | `String` | - | - |
16-
| resetFilterText | 重置按钮文本 | `String` | - | - |
17-
| hideByItemClick | 点击选项时，是否隐藏下拉框 | `Boolean` | - | false |
18-
| showRadio | 是否展示 radio，当是单选时生效 | `Boolean` | - | false |
19-
| visible | 下拉框是否展示，当 isControlled=true 生效 | `Boolean` | - | false |
20-
| isControlled | 是否是可控组件 | `Boolean` | - | false |
21-
| isCustomContent | 是否自定义下拉内容 | `Boolean` | - | false |
22-
| instance | 下拉面板和触发元素的距离 | `Number` | - | 12 |
5+
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
6+
| ---------------------------------- | --------------------------------------------------------- | ---------- | ------ | ------ |
7+
| isSelect | 是否供 select 组件使用 | `Boolean` | - | false |
8+
| showOperation | 展示操作按钮 | `Boolean` | - | false |
9+
| width | 下拉组件最小宽度 | `Number` | - | 90 |
10+
| maxWidth | 下拉组件最大宽度 | `Number` | - | 1000 |
11+
| isMultiple | 是否是多选下拉 | `Boolean` | - | false |
12+
| value | v-model 输入值 | `Array` | - | - |
13+
| textAlign | 下拉项居中方式 | `String` | - | "left" |
14+
| isInput | 是否包含 input | `Boolean` | - | false |
15+
| confirmFilterText | 确认按钮文本 | `String` | - | - |
16+
| resetFilterText | 重置按钮文本 | `String` | - | - |
17+
| hideByItemClick | 点击选项时，是否隐藏下拉框 | `Boolean` | - | false |
18+
| showRadio | 是否展示 radio，当是单选时生效 | `Boolean` | - | false |
19+
| visible | 下拉框是否展示，当 isControlled=true 生效 | `Boolean` | - | false |
20+
| isControlled | 是否是可控组件 | `Boolean` | - | false |
21+
| isCustomContent | 是否自定义下拉内容 | `Boolean` | - | false |
22+
| instance | 下拉面板和触发元素的距离 | `Number` | - | 12 |
23+
| beforeVisibleChange({nextVisible}) | 显示状态变更之前的回调方法，返回`false`则阻止显示状态变更 | `Function` | - | 12 |
2324

2425
### Event
2526

‎examples/src/docs/en/ve-dropdown/callback-methods.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
回调函数
2+
3+
:::demo
4+
5+
```html
6+
<template>
7+
<ve-dropdown hideByItemClick :beforeVisibleChange="beforeVisibleChange" v-model="options">
8+
<div style="color:blue;cursor: pointer;">点击这里</div>
9+
</ve-dropdown>
10+
</template>
11+
<script>
12+
export default {
13+
data() {
14+
return {
15+
options: [
16+
{ value: 0, label: "张三" },
17+
{ value: 1, label: "李四" },
18+
{ value: 2, label: "王二" },
19+
],
20+
};
21+
},
22+
methods: {
23+
beforeVisibleChange({ nextVisible }) {
24+
console.log("nextVisible::", nextVisible);
25+
},
26+
},
27+
};
28+
</script>
29+
```
30+
31+
:::

‎examples/src/docs/en/ve-dropdown/main.vue‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
<anchor label="自定义下拉内容" />
1818
<CustomContent />
1919
</div>
20+
<div>
21+
<anchor label="回调函数" />
22+
<callbackMethods />
23+
</div>
2024
<API />
2125
</div>
2226
</template>
@@ -26,6 +30,7 @@ import SingleSelect from "./single-select.md";
2630
import MultipleSelect from "./multiple-select.md";
2731
import Operation from "./operation.md";
2832
import CustomContent from "./custom-content.md";
33+
import callbackMethods from "./callback-methods.md";
2934
import API from "./api.md";
3035
3136
export default {
@@ -34,6 +39,7 @@ export default {
3439
MultipleSelect,
3540
Operation,
3641
CustomContent,
42+
callbackMethods,
3743
API,
3844
},
3945
};

‎examples/src/docs/zh/ve-dropdown/api.md‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,25 @@
22

33
### props
44

5-
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
6-
| ----------------- | ----------------------------------------- | --------- | ------ | ------ |
7-
| isSelect | 是否供 select 组件使用 | `Boolean` | - | false |
8-
| showOperation | 展示操作按钮 | `Boolean` | - | false |
9-
| width | 下拉组件最小宽度 | `Number` | - | 90 |
10-
| maxWidth | 下拉组件最大宽度 | `Number` | - | 1000 |
11-
| isMultiple | 是否是多选下拉 | `Boolean` | - | false |
12-
| value | v-model 输入值 | `Array` | - | - |
13-
| textAlign | 下拉项居中方式 | `String` | - | "left" |
14-
| isInput | 是否包含 input | `Boolean` | - | false |
15-
| confirmFilterText | 确认按钮文本 | `String` | - | - |
16-
| resetFilterText | 重置按钮文本 | `String` | - | - |
17-
| hideByItemClick | 点击选项时，是否隐藏下拉框 | `Boolean` | - | false |
18-
| showRadio | 是否展示 radio，当是单选时生效 | `Boolean` | - | false |
19-
| visible | 下拉框是否展示，当 isControlled=true 生效 | `Boolean` | - | false |
20-
| isControlled | 是否是可控组件 | `Boolean` | - | false |
21-
| isCustomContent | 是否自定义下拉内容 | `Boolean` | - | false |
22-
| instance | 下拉面板和触发元素的距离 | `Number` | - | 12 |
5+
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
6+
| ---------------------------------- | --------------------------------------------------------- | ---------- | ------ | ------ |
7+
| isSelect | 是否供 select 组件使用 | `Boolean` | - | false |
8+
| showOperation | 展示操作按钮 | `Boolean` | - | false |
9+
| width | 下拉组件最小宽度 | `Number` | - | 90 |
10+
| maxWidth | 下拉组件最大宽度 | `Number` | - | 1000 |
11+
| isMultiple | 是否是多选下拉 | `Boolean` | - | false |
12+
| value | v-model 输入值 | `Array` | - | - |
13+
| textAlign | 下拉项居中方式 | `String` | - | "left" |
14+
| isInput | 是否包含 input | `Boolean` | - | false |
15+
| confirmFilterText | 确认按钮文本 | `String` | - | - |
16+
| resetFilterText | 重置按钮文本 | `String` | - | - |
17+
| hideByItemClick | 点击选项时，是否隐藏下拉框 | `Boolean` | - | false |
18+
| showRadio | 是否展示 radio，当是单选时生效 | `Boolean` | - | false |
19+
| visible | 下拉框是否展示，当 isControlled=true 生效 | `Boolean` | - | false |
20+
| isControlled | 是否是可控组件 | `Boolean` | - | false |
21+
| isCustomContent | 是否自定义下拉内容 | `Boolean` | - | false |
22+
| instance | 下拉面板和触发元素的距离 | `Number` | - | 12 |
23+
| beforeVisibleChange({nextVisible}) | 显示状态变更之前的回调方法，返回`false`则阻止显示状态变更 | `Function` | - | 12 |
2324

2425
### Event
2526

‎examples/src/docs/zh/ve-dropdown/callback-methods.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
回调函数
2+
3+
:::demo
4+
5+
```html
6+
<template>
7+
<ve-dropdown hideByItemClick :beforeVisibleChange="beforeVisibleChange" v-model="options">
8+
<div style="color:blue;cursor: pointer;">点击这里</div>
9+
</ve-dropdown>
10+
</template>
11+
<script>
12+
export default {
13+
data() {
14+
return {
15+
options: [
16+
{ value: 0, label: "张三" },
17+
{ value: 1, label: "李四" },
18+
{ value: 2, label: "王二" },
19+
],
20+
};
21+
},
22+
methods: {
23+
beforeVisibleChange({ nextVisible }) {
24+
console.log("nextVisible::", nextVisible);
25+
},
26+
},
27+
};
28+
</script>
29+
```
30+
31+
:::

‎examples/src/docs/zh/ve-dropdown/main.vue‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
<anchor label="自定义下拉内容" />
1818
<CustomContent />
1919
</div>
20+
<div>
21+
<anchor label="回调函数" />
22+
<callbackMethods />
23+
</div>
2024
<API />
2125
</div>
2226
</template>
@@ -26,6 +30,7 @@ import SingleSelect from "./single-select.md";
2630
import MultipleSelect from "./multiple-select.md";
2731
import Operation from "./operation.md";
2832
import CustomContent from "./custom-content.md";
33+
import callbackMethods from "./callback-methods.md";
2934
import API from "./api.md";
3035
3136
export default {
@@ -34,6 +39,7 @@ export default {
3439
MultipleSelect,
3540
Operation,
3641
CustomContent,
42+
callbackMethods,
3743
API,
3844
},
3945
};

0 commit comments

Comments
 (0)