完善文档

This commit is contained in:
wanggeng 2022-08-29 22:22:41 +08:00
parent a7042d9650
commit e252ee3abb
2 changed files with 67 additions and 67 deletions

View File

@ -5,7 +5,7 @@ layui需要引入 **ztree** 模块
js
```html
<script src="assets/js/common/layui-input-tree.js"></script>
<script src="assets/js/layui/util/layui-input-tree.js"></script>
```
初始化
@ -60,7 +60,7 @@ layuiInputTree.initSelect({
参数
| 名称 | 类型 | 描述 | 是否必填 |
|---|---|---|---|
|-----------------|----------|--------------------------------------------------------------------------------------------------------------------|------|
| url | string | 请求地址 | 是 |
| id | string | 触发选择的input输入框ID | 是 |
| key | obj | 返回列表对象与ztree节点匹配的字段。id:节点idname:名称title:标题pId:上级IDchecked:是否选中isParent:是否父节点isHidden是否隐藏url:节点链接。以上属性均为非必填 | 否 |
@ -78,14 +78,14 @@ getSelectedData返回ztree回显时的数据
onConfirm树形列表点击确定按钮后触发
| 名称 | 类型 | 描述 |
|---|---|---------|
|--------------|-----|---------|
| zTree | obj | ztree对象 |
| selectedNode | obj | 选择的节点 |
onClear树形列表点击清空按钮后触发
| 名称 | 类型 | 描述 |
|---|---|---------|
|-------|-----|---------|
| zTree | obj | ztree对象 |
### 多选
@ -143,7 +143,7 @@ layuiInputTree.initMultiSelect({
参数
| 名称 | 类型 | 描述 | 是否必填 |
|---|---|---|------|
|------------------|----------|--------------------------------------------------------------------------------------------------------------------|------|
| url | string | 请求地址 | 是 |
| id | string | 触发选择的input输入框ID | 是 |
| key | obj | 返回列表对象与ztree节点匹配的字段。id:节点idname:名称title:标题pId:上级IDchecked:是否选中isParent:是否父节点isHidden是否隐藏url:节点链接。以上属性均为非必填 | 否 |
@ -162,12 +162,12 @@ getSelectedDatas返回ztree回显时的数据列表
onConfirm树形列表点击确定按钮后触发
| 名称 | 类型 | 描述 |
|---|---|-----------|
|---------------|-------|-----------|
| zTree | obj | ztree对象 |
| selectedNodes | array | 触发选择的节点列表 |
onClear树形列表点击清空按钮后触发
| 名称 | 类型 | 描述 |
|---|---|---------|
|-------|-----|---------|
| zTree | obj | ztree对象 |

View File

@ -36,7 +36,7 @@
js
```js
<script src="assets/js/common/layui-select.js"></script>
<script src="assets/js/layui/util/layui-select.js"></script>
```
初始化
@ -100,12 +100,12 @@ layuiSelect.selectData({
参数
| 名称 | 类型 | 描述 | 是否必填 |
|---|----------|----------------------------------------------------------|------|
|--------------------|----------|----------------------------------------------------------|------|
| url | string | 请求地址 | 是 |
| domId | string | 加载下拉的div | 是 |
| name | string | select的ID与NAME属性值 | 是 |
| required | boolean | 是否校验 | 否 |
|dataForm| string | 表单的lay-filter值 | 是 |
| dataForm | string | 表单的lay-filter值不存在渲染全部的select | 否 |
| valueKey | string | 接口返回的数据渲染到option的value属性的值 | 是 |
| nameKey | string | 接口返回的数据渲染到option的innerText的值 | 是 |
| selectedValue | string | 选中的默认值 | 否 |
@ -118,14 +118,14 @@ layuiSelect.selectData({
onInit渲染或更新时触发事件
| 名称 | 类型 | 描述 |
|---|--------|----------------------|
|---------------|--------|----------------------|
| selectedValue | string | 选中的默认值,空字符串时,不触发数据加载 |
| option | dom | 默认选中的option |
onSelect选择时触发事件
| 名称 | 类型 | 描述 |
|---|---|----------------------------------|
|--------|-----|----------------------------------|
| data | obj | 选择的option数据包含原始DOM美化后的DOM选中的值 |
| option | dom | 选中的option |
@ -181,7 +181,7 @@ layuiSelect.selectLinkageArea({
参数
| 名称 | 类型 | 描述 | 是否必填 |
|---|---|---|------|
|--------------------|----------|----------------------------------------------------------|------|
| baseRootId | string | 第一个下拉框的根节点ID | 是 |
| selectId | string | select的ID不包含下标 | 是 |
| optionDataKeyArray | array | 需要附带在option上的属性值取值的时候通过option.dataset.dataX 获取其中X为数组下标 | 否 |
@ -192,7 +192,7 @@ layuiSelect.selectLinkageArea({
onSelect选择时触发事件
| 名称 | 类型 | 描述 |
|---|---|----------------------------------|
|--------|--------|----------------------------------|
| data | obj | 选择的option数据包含原始DOM美化后的DOM选中的值 |
| option | dom | 选中的option |
| index | number | select下标 |