c8c7c027561813da3dc308a6a723699b40897f43.svn-base 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. ## 写在前面
  2. 此组件仅提供一个创建TreeTable的解决思路
  3. ## prop说明
  4. #### *data*
  5. **必填**
  6. 原始数据,要求是一个数组或者对象
  7. ```javascript
  8. [{
  9. key1: value1,
  10. key2: value2,
  11. children: [{
  12. key1: value1
  13. },
  14. {
  15. key1: value1
  16. }]
  17. },
  18. {
  19. key1: value1
  20. }]
  21. ```
  22. 或者
  23. ```javascript
  24. {
  25. key1: value1,
  26. key2: value2,
  27. children: [{
  28. key1: value1
  29. },
  30. {
  31. key1: value1
  32. }]
  33. }
  34. ```
  35. #### columns
  36. 列属性,要求是一个数组
  37. 1. text: 显示在表头的文字
  38. 2. value: 对应data的key。treeTable将显示相应的value
  39. 3. width: 每列的宽度,为一个数字(可选)
  40. 如果你想要每个字段都有自定义的样式或者嵌套其他组件,columns可不提供,直接像在el-table一样写即可,如果没有自定义内容,提供columns将更加的便捷方便
  41. 如果你有几个字段是需要自定义的,几个不需要,那么可以将不需要自定义的字段放入columns,将需要自定义的内容放入到slot中,详情见后文
  42. ```javascript
  43. [{
  44. value:string,
  45. text:string,
  46. width:number
  47. },{
  48. value:string,
  49. text:string,
  50. width:number
  51. }]
  52. ```
  53. #### expandAll
  54. 是否默认全部展开,boolean值,默认为false
  55. #### evalFunc
  56. 解析函数,function,非必须
  57. 如果不提供,将使用默认的[evalFunc](./eval.js)
  58. 如果提供了evalFunc,那么会用提供的evalFunc去解析data,并返回treeTable渲染所需要的值。如何编写一个evalFunc,请参考[*eval.js*](https://github.com/PanJiaChen/vue-element-admin/blob/master/src/components/TreeTable/eval.js)或[*customEval.js*](https://github.com/PanJiaChen/vue-element-admin/blob/master/src/views/example/table/treeTable/customEval.js)
  59. #### evalArgs
  60. 解析函数的参数,是一个数组
  61. **请注意,自定义的解析函数参数第一个为this.data,第二个参数为, this.expandAll,你不需要在evalArgs填写。一定记住,这两个参数是强制性的,并且位置不可颠倒** *this.data为需要解析的数据,this.expandAll为是否默认展开*
  62. 如你的解析函数需要的参数为`(this.data, this.expandAll,1,2,3,4)`,那么你只需要将`[1,2,3,4]`赋值给`evalArgs`就可以了
  63. 如果你的解析函数参数只有`(this.data, this.expandAll)`,那么就可以不用填写evalArgs了
  64. 具体可参考[*customEval.js*](https://github.com/PanJiaChen/vue-element-admin/blob/master/src/views/example/table/treeTable/customEval.js)的函数参数和[customTreeTable](https://github.com/PanJiaChen/vue-element-admin/blob/master/src/views/example/table/treeTable/customTreeTable.vue)的`evalArgs`属性值
  65. ## slot
  66. 这是一个自定义列的插槽。
  67. 默认情况下,treeTable只有一行行展示数据的功能。但是一般情况下,我们会要给行加上一个操作按钮或者根据当行数据展示不同的样式,这时我们就需要自定义列了。请参考[customTreeTable](https://github.com/PanJiaChen/vue-element-admin/blob/master/src/views/example/table/treeTable/customTreeTable.vue),[实例效果](http://panjiachen.github.io/vue-element-admin/#/example/table/custom-tree-table)
  68. `slot`和`columns属性`可同时存在,columns里面的数据列会在slot自定义列的左边展示
  69. ## 其他
  70. 如果有其他的需求,请参考[el-table](http://element-cn.eleme.io/#/en-US/component/table)的api自行修改index.vue