单选多选的树表参照
$ npm install ref-tree-table --save
引入
import RefTreeTableBaseUI from 'ref-tree-table';
或者
import { RefTreeTableWithInput } from 'ref-tree-table'
样式
import 'ref-tree-table/lib/index.css';
RefTreeTableBaseUI (默认)
树表的通用ui
RefTreeTableWithInput
带文本框的参照弹出窗。
RefTreeTableBaseUI接收的参数部分用于左树，部分用于右表
| 参数 | 类型 | 默认值 | 说明 | 必选 |
|---|---|---|---|---|
| title | string |
空 | 打开上传的模态框显示的标题文字 | 否 |
| className | string |
空 | 参照class样式，作用于弹出层和输入框的样式以及左树右表外层类名，默认为空。 | 否 |
| backdrop | bool |
true | 弹出层是否有模态层，true 显示，false 不显示 | 否 |
| value | string |
空 | 带有input框参照的input初始值。格式必须符合'{"refname":"初级-T1","refpk":"level1"}'。refname和refpk必须有，refpk表示该条数据的键，应取valueFiled指定值。 |
否 |
| lang | string |
zh_CN |
多语配置。取值范围[en_US,zh_TW,fr_FR,de_DE,ja_JP,zh_CN] | 否 |
| buttons | object |
{okText:'确认',cancelText:'取消',clearText:"清空已选"} |
okText: "确认", //确认按钮cancelText: "取消", //取消按钮clearText: "清空已选" //清空已选按钮 |
弹出层工具栏三个按钮的文字，若 |
| onSave | function( record:object ) |
-- | 保存回调函数，返回已选择的记录详细数据。 | 否 |
| onCancel | function( ) |
-- | 关闭弹出层 | 否 |
| menuTitle | String |
'' | 左树的标题 | 否 |
| tableTitle | String |
'' | 右表的标题 | 否 |
| showModal | Boolean |
false | 参照是否打开。 | 是 |
| theme | String |
'ref-red' | 启用参照内部默认样式。theme=''，不使用参照默认样式。 | 否 |
| showLoading | bool |
false | 是否展示loading，多用于请求中 | 否 |
| valueField | string |
'refpk' | 待提交的value的键。或者说指定真实数据的键。要求具有唯一性。左树右表一致,都需要 | 否 |
| mustPaginationShow | bool |
false | true必须展示分页、false，当pageCount>1才展示分页 | 否 |
| tableProps | object |
{} | table上其他属性，具体接收的参数参照table | 否 |
| modalProps | object |
{} | modal上其他属性，具体接收的参数参照modal | 否 |
| isLocalSearch | bool |
false | 树的搜索是否是前端搜索，false是调用函数getRefTreeData(value),true是前端搜索 | 否 |
| footerBtnDom | dom |
'' | 自定义footer的按钮dom | 否 |
左树
| 参数 | 类型 | 默认值 | 说明 | 必选 |
|---|---|---|---|---|
| searchable | bool |
false | 是否显示搜索框，弹出层是否带有搜索框，true 显示，false 不显示。 | 否 |
| nodeDisplay | string 或 function |
{refname} |
节点渲染时可匹配的内容，这里为了提供根据数据渲染节点图标使用 | 否 |
| lazyModal | bool |
false | 树参照是异步加载，回调onLoadData | 否 |
| defaultExpandAll | bool |
true | 展开所有节点，true 展开，false 不展开。前提lazyModal是false，懒加载下该属性不起效。 | 否 |
| showLine | bool |
false | 树组件是否有连线 | 否 |
| onChange | function(checkedArray) |
-- | 右表选中回调函数 | 否 |
| nodeDisplay | string 或 function |
'{refname}' | 左树节点展示形式。 当为字符串时则会根据 {}包裹的增则匹配替换。如： '人员姓名：{refname}，编号：{refcode}'当为函数时则需自定义返回内容，参数为迭代已选择的记录。 如： displayField: (record)=> ${record.refname}-${record.refname} |
否 |
| treeData | Array |
[] | 左树数据 | 否 |
| onTreeChange | function(checkedArray) |
()=>{} | 选择树节点的回调，返回选中的树节点 | 否 |
| onTreeSearch | function(searchVal) |
()=>{} | 左树上的搜索回调 | 否 |
| onLoadData | function(treeNode) |
-- | 懒加载传个树的回调方法。与lazyModal配合使用，lazyModal=true才会回调该函数 | 否 |
| checkedTreeArray | array |
[] | 左树默认选中的节点，每项至少包含valueField指定字段，比如valueFiled='refpk',checedTreeArray=[{refpk:'yonyou'},...] | 否 |
右表
| 参数 | 类型 | 默认值 | 说明 | 必选 |
|---|---|---|---|---|
| matchData | Array |
[] | 选中的节点，选中节点只从matchData中获取。matchData是全部选中的数据 | 否 |
| multiple | bool |
false | 右表是否单选， true 单选，false 多选。左树总是单选 | 否 |
| columnsData | Array |
[] | 右表列数据。具体参照tinper-bee的table组件 | 否 |
| tableData | Array | [] | 右表表体数据。具体参照tinper-bee的table组件 | 否 |
| page | Object |
{pageCount:0,currPageIndex:0,totalElements:0} | 分页数据信息。 | 否 |
| loadTableData | function(param) |
()=>{} | 分页下拉或者跳转的回调，返回参数。参数包含{refClientPageInfo.currPageIndex:分页当前页码,refClientPageInfo.pageSize:每页展示的数据量,content:搜索条件} | 否 |
| onTableSearch | function(value) |
()=>{} | 表格搜索的回调，参数是搜索条件 | 否 |
RefTreeTableWithInput可以使用RefTreeTableBaseUI的参数（除了showModal），还可以使用以下参数。
| 参数 | 类型 | 默认值 | 说明 | 必选 |
|---|---|---|---|---|
| wrapClassName | string |
空 | 文本框的class样，默认为空。 | 否 |
| placeholder | string |
空 | 文本框的 placeholder | 否 |
| style | object |
{width:200} | 文本框的style，默认宽度200px | 否 |
| filterUrl | string |
空 | 快捷录入接口。 | 否 |
| filterUrlFunc | function(value) |
()=>{} | 必须配合filterUrl使用，当filterUrl为空或者不传入，才会回调filterUrlFunc | 否 |
| filterData | Array |
[] | 必须配合filterUrlFunc使用，filterData是过滤列表全部数据 | 否 |
| displayField | string 或 function |
'{refname}' |
当为字符串时则会根据 {}包裹的增则匹配替换。如： {refname}当为函数时则需自定义返回内容，参数为迭代已的记录。 如： displayField: (record)=> ${record.refname}-${record.refname}，是input展示value |
否 |
| inputDisplay | string 或 function |
'{refname}' | input中显示的内容的格式。 当为字符串时则会根据 {}包裹的增则匹配替换。如： {refname}当为函数时则需自定义返回内容，参数为迭代已的记录。 如： displayField: (record)=> ${record.refname}-${record.refname}，是input展示value |
否 |
| value | `string | array[object]` | 空 | 带有input框参照的input默认值，展示形式配合displayField。格式符合'{"refname":"初级-T1","refpk":"level1"}'。refname和refpk必须有，refpk表示该条数据的键，应取valueFiled指定值。或者数组格式(适合多选)，[object1,object2...] |
| disabled | bool |
false | 禁用整个input框 | 否 |
| onChange | function(values, record) |
-- | value改变、选中过滤数据和保存时数据回调。values是obj，格式{'refname':'','refpk':''},record是该条完整数据 | 否 |
| canClickGoOn | function() |
()=>{return true} | 当点击文本框右侧弹出按钮时是否打开modal 适用于级联情况下当选择不全时的处理 |
否 |
| canInputGoOn | function() |
()=>{return true} | 当点击文本框触发快捷录入时是否可以录入 适用于级联情况下当选择不全时的处理 |
否 |
| menuIcon | dom |
input框参照打开按钮，默认汉堡按钮 | 否 | |
| dropdownDisabled | boolean |
false | 下拉展示是否可以弹出，false为有，true为没有 | 否 |
| treeNodeDisabledKey | String |
- | 树节点中disabled状态节点，传入代表treeData中表示不可选节点的键 | 否 |
| treeNodeDisabledFunc | function(node) |
返回当前节点信息，return false，表示可选；return true，表示该节点不可选 | 否 | |
| footerBtnDom | dom |
'' | 自定义footer的按钮dom | 否 |
-
1.input框的展示值
- 1.1 input框的初始值，只从value的refname中获取
- 1.2 参照进行保存操作之后（点击参照确认按钮），input框展示由inputDisplay来决定
-
2.value、inputDisplay、 displayField
2.1 value和inputDisplay是针对input框来说。
2.2 value格式可以是
'{"refname":"初级-T1","refpk":"level1"}'或者数组[object1,object2...]。refname字段不可变，refpk是该数据键，要求具有唯一性；object中应包含数据项具体信息。2.3 inputDisplay确定input中显示内容的格式，displayField过滤列表显示内容的格式。inputDisplay和displayField中使用到的字段必须是filterData,matchData和treeData数据项中都含有的字段。
inputDisplay和displayField具体使用参考demo3
注意：value格式是
'{"refname":"初级-T1","refpk":"level1"}'，inputDisplay只包含refname或者refpk -
3.value、valueFiled
value初始化input框值，是input需要使用的数据，要求如上。 valueFiled指定数据源的键，要求具有唯一性。 因此value中refpk指定值应与valueFiled取值一致。
注意，在多选情况下，value是字符串
'{"refname":"初级-T1","refpk":"level1"}'格式，那么valueFiled只能指定是refpk；value是数组，valueField可以是其他字段 具体使用参考demo3 -
4.value、matchData
value初始化input框值，matchData是指定参照中选中的节点。具体参照demo3，value与matchData并不完全相同
- 4.1 如果value有值matchData为空，那么input有值但是参照无选中数据；
- 4.2 反之value空值matchData有值，那么input为空但是参照有选中数据；
- 4.3 如果value与matchData都有值，但是不匹配，树中选中数据按照matchData。
