Skip to content

Commit 13e9966

Browse files
committed
docs: 添加全局注册组件文档
1 parent 1a86316 commit 13e9966

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

packages/docs/docs/.vuepress/localesConfig/genConfig.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ exports.getGuideSidebar = ([groupA = '指南', groupB = '详细配置', groupC =
3030
children: [
3131
'',
3232
'basic-config',
33+
'components',
3334
'datetime-config',
3435
'validate',
3536
'i18n',
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# 全局注册组件
2+
3+
`vjsf` 在运行中会自动注册如下全局组件,这些组件都是在渲染 `Widget` 所使用
4+
5+
* [CheckboxesWidget](#checkboxeswidget)
6+
* [RadioWidget](#radiowidget)
7+
* [SelectWidget](#selectwidget)
8+
* [TimePickerWidget](#timepickerwidget)
9+
* [DatePickerWidget](#datepickerwidget)
10+
* [DateTimePickerWidget](#datetimepickerwidget)
11+
12+
## CheckboxesWidget
13+
复选框组,内部使用 elementUi `el-checkbox-group` 组件
14+
15+
### props
16+
* `value/v-model` `required`,类型 [`Array`]
17+
* `enumOptions` `数组` 选项列表,结构如:`[{value: '1', label: '选项一'}]`,value 为值,label 为显示标签
18+
19+
> 传递其它额外的参数会透传给 `el-checkbox-group` 组件
20+
21+
## RadioWidget
22+
单选框组,内部使用 elementUi `el-radio-group` 组件
23+
24+
### props
25+
* `value/v-model` `required`,类型 [`String`, `Number`, `Boolean`]
26+
* `enumOptions` `数组` 选项列表,结构如:`[{value: '1', label: '选项一'}]`,value 为值,label 为显示标签
27+
28+
> 传递其它额外的参数会透传给 `el-radio-group` 组件
29+
30+
## SelectWidget
31+
下拉选择,内部使用 elementUi `el-select` 组件
32+
33+
### props
34+
* `value/v-model` `required`,任意类型
35+
* `enumOptions` `数组` 选项列表,结构如:`[{value: '1', label: '选项一'}]`,value 为值,label 为显示标签
36+
37+
> 传递其它额外的参数会透传给 `el-select` 组件
38+
39+
## TimePickerWidget
40+
> 内部做时间日期选择使用,一般不要配置自定义 `widget` 中使用
41+
42+
## DatePickerWidget
43+
> 内部做时间日期选择使用,一般不要配置自定义 `widget` 中使用
44+
45+
## DateTimePickerWidget
46+
> 内部做时间日期选择使用,一般不要配置自定义 `widget` 中使用
47+

0 commit comments

Comments
 (0)