完善文档
This commit is contained in:
parent
a7042d9650
commit
e252ee3abb
@ -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>
|
||||
```
|
||||
|
||||
初始化
|
||||
@ -59,15 +59,15 @@ layuiInputTree.initSelect({
|
||||
|
||||
参数
|
||||
|
||||
|名称|类型|描述|是否必填|
|
||||
|---|---|---|---|
|
||||
|url|string|请求地址|是|
|
||||
|id|string|触发选择的input输入框ID|是|
|
||||
|key|obj|返回列表对象与ztree节点匹配的字段。id:节点id；name:名称；title:标题，pId:上级ID；checked:是否选中；isParent:是否父节点；isHidden：是否隐藏；url:节点链接。以上属性均为非必填|否|
|
||||
|defaultParams|obj|请求默认携带的参数|否|
|
||||
|getSelectedData|function|返回已经选择的数据|否|
|
||||
|onConfirm|function|点击确定按钮后触发|否|
|
||||
|onClear|function|点击清除按钮后触发|否|
|
||||
| 名称 | 类型 | 描述 | 是否必填 |
|
||||
|-----------------|----------|--------------------------------------------------------------------------------------------------------------------|------|
|
||||
| url | string | 请求地址 | 是 |
|
||||
| id | string | 触发选择的input输入框ID | 是 |
|
||||
| key | obj | 返回列表对象与ztree节点匹配的字段。id:节点id；name:名称；title:标题，pId:上级ID；checked:是否选中；isParent:是否父节点；isHidden：是否隐藏；url:节点链接。以上属性均为非必填 | 否 |
|
||||
| defaultParams | obj | 请求默认携带的参数 | 否 |
|
||||
| getSelectedData | function | 返回已经选择的数据 | 否 |
|
||||
| onConfirm | function | 点击确定按钮后触发 | 否 |
|
||||
| onClear | function | 点击清除按钮后触发 | 否 |
|
||||
|
||||
方法
|
||||
|
||||
@ -77,16 +77,16 @@ getSelectedData：返回ztree回显时的数据
|
||||
|
||||
onConfirm：树形列表点击确定按钮后触发
|
||||
|
||||
|名称|类型| 描述 |
|
||||
|---|---|---------|
|
||||
|zTree|obj| ztree对象 |
|
||||
|selectedNode|obj| 选择的节点 |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|--------------|-----|---------|
|
||||
| zTree | obj | ztree对象 |
|
||||
| selectedNode | obj | 选择的节点 |
|
||||
|
||||
onClear：树形列表点击清空按钮后触发
|
||||
|
||||
|名称|类型| 描述 |
|
||||
|---|---|---------|
|
||||
|zTree|obj| ztree对象 |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|-------|-----|---------|
|
||||
| zTree | obj | ztree对象 |
|
||||
|
||||
### 多选
|
||||
|
||||
@ -142,16 +142,16 @@ layuiInputTree.initMultiSelect({
|
||||
|
||||
参数
|
||||
|
||||
|名称|类型|描述| 是否必填 |
|
||||
|---|---|---|------|
|
||||
|url|string|请求地址| 是 |
|
||||
|id|string|触发选择的input输入框ID| 是 |
|
||||
|key|obj|返回列表对象与ztree节点匹配的字段。id:节点id；name:名称；title:标题，pId:上级ID；checked:是否选中；isParent:是否父节点；isHidden：是否隐藏；url:节点链接。以上属性均为非必填| 否 |
|
||||
|checkboxType|obj|复选框类型，Y 属性定义 checkbox 被勾选后的情况；N 属性定义 checkbox 取消勾选后的情况；"p" 表示作会影响父级节点；"s" 表示操作会影响子级节点。默认均为"ps"| 否 |
|
||||
|defaultParams|obj|请求默认携带的参数| 否 |
|
||||
|getSelectedDatas|function|返回已经选择的数据列表| 否 |
|
||||
|onConfirm|function|点击确定按钮后触发| 否 |
|
||||
|onClear|function|点击清除按钮后触发| 否 |
|
||||
| 名称 | 类型 | 描述 | 是否必填 |
|
||||
|------------------|----------|--------------------------------------------------------------------------------------------------------------------|------|
|
||||
| url | string | 请求地址 | 是 |
|
||||
| id | string | 触发选择的input输入框ID | 是 |
|
||||
| key | obj | 返回列表对象与ztree节点匹配的字段。id:节点id；name:名称；title:标题，pId:上级ID；checked:是否选中；isParent:是否父节点；isHidden：是否隐藏；url:节点链接。以上属性均为非必填 | 否 |
|
||||
| checkboxType | obj | 复选框类型，Y 属性定义 checkbox 被勾选后的情况；N 属性定义 checkbox 取消勾选后的情况；"p" 表示作会影响父级节点；"s" 表示操作会影响子级节点。默认均为"ps" | 否 |
|
||||
| defaultParams | obj | 请求默认携带的参数 | 否 |
|
||||
| getSelectedDatas | function | 返回已经选择的数据列表 | 否 |
|
||||
| onConfirm | function | 点击确定按钮后触发 | 否 |
|
||||
| onClear | function | 点击清除按钮后触发 | 否 |
|
||||
|
||||
方法
|
||||
|
||||
@ -161,13 +161,13 @@ getSelectedDatas：返回ztree回显时的数据列表
|
||||
|
||||
onConfirm：树形列表点击确定按钮后触发
|
||||
|
||||
|名称|类型| 描述 |
|
||||
|---|---|-----------|
|
||||
|zTree|obj| ztree对象 |
|
||||
|selectedNodes|array| 触发选择的节点列表 |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|---------------|-------|-----------|
|
||||
| zTree | obj | ztree对象 |
|
||||
| selectedNodes | array | 触发选择的节点列表 |
|
||||
|
||||
onClear：树形列表点击清空按钮后触发
|
||||
|
||||
|名称|类型| 描述 |
|
||||
|---|---|---------|
|
||||
|zTree|obj| ztree对象 |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|-------|-----|---------|
|
||||
| zTree | obj | ztree对象 |
|
||||
|
||||
@ -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>
|
||||
```
|
||||
|
||||
初始化
|
||||
@ -99,35 +99,35 @@ layuiSelect.selectData({
|
||||
|
||||
参数
|
||||
|
||||
|名称| 类型 | 描述 | 是否必填 |
|
||||
|---|----------|----------------------------------------------------------|------|
|
||||
|url| string | 请求地址 | 是 |
|
||||
|domId| string | 加载下拉的div | 是 |
|
||||
|name| string | select的ID与NAME属性值 | 是 |
|
||||
|required| boolean | 是否校验 | 否 |
|
||||
|dataForm| string | 表单的lay-filter值 | 是 |
|
||||
|valueKey| string | 接口返回的数据渲染到option的value属性的值 | 是 |
|
||||
|nameKey| string | 接口返回的数据渲染到option的innerText的值 | 是 |
|
||||
|selectedValue| string | 选中的默认值 | 否 |
|
||||
|optionDataKeyArray| array | 需要附带在option上的属性值，取值的时候通过option.dataset.dataX 获取，其中X为数组下标 | 否 |
|
||||
|onInit| function | 渲染时触发回调 | 否 |
|
||||
|onSelect| function | 选择时触发回调 | 否 |
|
||||
| 名称 | 类型 | 描述 | 是否必填 |
|
||||
|--------------------|----------|----------------------------------------------------------|------|
|
||||
| url | string | 请求地址 | 是 |
|
||||
| domId | string | 加载下拉的div | 是 |
|
||||
| name | string | select的ID与NAME属性值 | 是 |
|
||||
| required | boolean | 是否校验 | 否 |
|
||||
| dataForm | string | 表单的lay-filter值，不存在渲染全部的select | 否 |
|
||||
| valueKey | string | 接口返回的数据渲染到option的value属性的值 | 是 |
|
||||
| nameKey | string | 接口返回的数据渲染到option的innerText的值 | 是 |
|
||||
| selectedValue | string | 选中的默认值 | 否 |
|
||||
| optionDataKeyArray | array | 需要附带在option上的属性值，取值的时候通过option.dataset.dataX 获取，其中X为数组下标 | 否 |
|
||||
| onInit | function | 渲染时触发回调 | 否 |
|
||||
| onSelect | function | 选择时触发回调 | 否 |
|
||||
|
||||
事件
|
||||
|
||||
onInit：渲染或更新时触发事件
|
||||
|
||||
|名称| 类型 | 描述 |
|
||||
|---|--------|----------------------|
|
||||
|selectedValue| string | 选中的默认值，空字符串时，不触发数据加载 |
|
||||
|option| dom | 默认选中的option |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|---------------|--------|----------------------|
|
||||
| selectedValue | string | 选中的默认值，空字符串时，不触发数据加载 |
|
||||
| option | dom | 默认选中的option |
|
||||
|
||||
onSelect：选择时触发事件
|
||||
|
||||
|名称|类型| 描述 |
|
||||
|---|---|----------------------------------|
|
||||
|data|obj| 选择的option数据，包含原始DOM，美化后的DOM，选中的值 |
|
||||
|option|dom| 选中的option |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|--------|-----|----------------------------------|
|
||||
| data | obj | 选择的option数据，包含原始DOM，美化后的DOM，选中的值 |
|
||||
| option | dom | 选中的option |
|
||||
|
||||
### 下拉联动
|
||||
|
||||
@ -180,19 +180,19 @@ layuiSelect.selectLinkageArea({
|
||||
|
||||
参数
|
||||
|
||||
|名称|类型|描述| 是否必填 |
|
||||
|---|---|---|------|
|
||||
|baseRootId|string|第一个下拉框的根节点ID| 是 |
|
||||
|selectId|string|select的ID（不包含下标）| 是 |
|
||||
|optionDataKeyArray|array|需要附带在option上的属性值，取值的时候通过option.dataset.dataX 获取，其中X为数组下标| 否 |
|
||||
|onSelect|function|选择事件| 是 |
|
||||
| 名称 | 类型 | 描述 | 是否必填 |
|
||||
|--------------------|----------|----------------------------------------------------------|------|
|
||||
| baseRootId | string | 第一个下拉框的根节点ID | 是 |
|
||||
| selectId | string | select的ID（不包含下标） | 是 |
|
||||
| optionDataKeyArray | array | 需要附带在option上的属性值，取值的时候通过option.dataset.dataX 获取，其中X为数组下标 | 否 |
|
||||
| onSelect | function | 选择事件 | 是 |
|
||||
|
||||
事件
|
||||
|
||||
onSelect：选择时触发事件
|
||||
|
||||
|名称|类型| 描述 |
|
||||
|---|---|----------------------------------|
|
||||
|data|obj| 选择的option数据，包含原始DOM，美化后的DOM，选中的值 |
|
||||
|option|dom| 选中的option |
|
||||
|index|number| select下标 |
|
||||
| 名称 | 类型 | 描述 |
|
||||
|--------|--------|----------------------------------|
|
||||
| data | obj | 选择的option数据，包含原始DOM，美化后的DOM，选中的值 |
|
||||
| option | dom | 选中的option |
|
||||
| index | number | select下标 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user