# BsTree 文档

l

<template>
  <DocTable
    :table-data="tableData"
  />
</template>

<script>
  export default {
    data() {
      return {
        tableData: [
          {
            keyName: 'Props',
            desc: '参数',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'title',
                desc: '标题',
                type: 'string',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'defaultExpandedKeys',
                desc: '默认展开的节点的 key 的数组',
                type: 'array',
                enum: '',
                defVal: '[]',
                emc: ''
              },
              {
                keyName: 'defaultCheckedKeys',
                desc: '默认勾选的节点的 key 的数组',
                type: 'array',
                enum: '',
                defVal: '[]',
                emc: ''
              },
              {
                keyName: 'currentNodeKey',
                desc: '当前选中的节点',
                type: '',
                enum: 'string, number',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'isDropSelectTree',
                desc: '是不是下拉树, 默认是普通树',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'filterText',
                desc: '过滤文本',
                type: 'string',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'editable',
                desc: '下拉树是不是可编辑树',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'value',
                desc: '选中的值 node,其中当为普通树时必须为node节点对象而非id',
                type: '[Object, array, string]',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'disabledNodeIds',
                desc: '默认禁用节点的 key 的数组',
                type: 'array',
                enum: '',
                defVal: '[]',
                emc: ''
              },
              {
                keyName: 'limitCheckedEnd',
                desc: '多选下拉树是否限制只能选取末级节点',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'limitClassifySingleCheck',
                desc: '多选时,在限制只能选末级条件下,是否每个分类级别下只能选中一个节点数据',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'queryparams',
                desc: '请求参数',
                type: 'Object',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'treeData',
                desc: '树展示数据: 1、当config.url为空时采用传入数据 2、当config.url有值时采用请求的数据',
                type: 'array',
                enum: '',
                defVal: '[]',
                emc: ''
              },
              {
                keyName: 'isVueEasyTree',
                desc: '树数据量大于1000条时是否开启虚拟滚动, 默认开启',
                type: 'boolean',
                enum: '',
                defVal: 'true',
                emc: ''
              },
              {
                keyName: 'config',
                desc: '树配置',
                type: 'Object',
                enum: '',
                defVal: '',
                emc: '',
                children: [
                  {
                    keyName: 'checkOnClickNode',
                    desc: '是否在点击节点的时候选中节点,默认值为 false,即只有在点击复选框时才会选中节点',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'destroyOnClose',
                    desc: '在下拉容器关闭时销毁内容',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'refreshTreeDataOnDrop',
                    desc: '是否每次渲染下拉重新加载数据',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'expandOnClickNode',
                    desc: '是否在点击节点的时候展开或者收缩节点, 默认值为 true,如果为 false,则只有点箭头图标的时候才会展开或者收缩节点。',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'showFilter',
                    desc: '是否显示过滤',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'isInitLoadData',
                    desc: '是否初始化时加载数据',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'scrollLoad',
                    desc: '是否开启滚动加载',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'isleaf',
                    desc: '指定节点是否为叶子节点',
                    type: 'string',
                    enum: '',
                    defVal: '',
                    emc: ''
                  },
                  {
                    keyName: 'levelno',
                    desc: '可选层级',
                    type: 'number',
                    enum: '',
                    defVal: "isleaf: '', levelno: -1 随便选 // isleaf:'', levelno: 2 只能选择levelno为2的层级 //  isleaf: true, levelno: -1,只能选择最底级",
                    emc: ''
                  },
                  {
                    keyName: 'valueKeys',
                    desc: 'valueKeys',
                    type: '',
                    enum: '',
                    defVal: "['code', 'name', 'id']",
                    emc: ''
                  },
                  {
                    keyName: 'placeholder',
                    desc: '当值为空时,显示的占位符',
                    type: 'string',
                    enum: '',
                    defVal: '',
                    emc: ''
                  },
                  {
                    keyName: 'disabled',
                    desc: '是否禁用',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'tooltip',
                    desc: '是否显示tooltip提示',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'highlightCurrent',
                    desc: '是否高亮当前选中节点,默认值是 false。',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'isPramas',
                    desc: '请求参数是否包裹到params中',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'multiple',
                    desc: '是否多选',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'isLazeLoad',
                    desc: '是否懒加载子节点,需与 load 方法结合使用',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'readonly',
                    desc: 'Input是否只读',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'clearable',
                    desc: 'Input当有值时,是否在右侧显示清除按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'customBgConfig',
                    desc: '自定义背景色配置',
                    type: 'Object',
                    enum: '',
                    defVal: '',
                    emc: '',
                    children: [
                      {
                        keyName: 'isCustom',
                        desc: '是否自定义背景色',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      },
                      {
                        keyName: 'bg',
                        desc: '背景色值',
                        type: 'string',
                        enum: '',
                        defVal: '',
                        emc: ''
                      },
                      {
                        keyName: 'justFied',
                        desc: '判断字段',
                        type: 'string',
                        enum: '',
                        defVal: '',
                        emc: ''
                      },
                      {
                        keyName: 'targetVal',
                        desc: '判断字段目标值',
                        type: 'string',
                        enum: '',
                        defVal: '',
                        emc: ''
                      }
                    ]
                  },
                  {
                    keyName: 'treeProps',
                    desc: '树配置选项',
                    type: 'Object',
                    enum: '',
                    defVal: '',
                    emc: '',
                    children: [
                      {
                        keyName: 'label',
                        desc: '当labelFormat为空时,树节点渲染时显示哪个字段',
                        type: 'string',
                        enum: '',
                        defVal: 'name',
                        emc: ''
                      },
                      {
                        keyName: 'nodeKey',
                        desc: '树的主键',
                        type: 'string',
                        enum: '',
                        defVal: 'id',
                        emc: ''
                      },
                      {
                        keyName: 'children',
                        desc: '树的嵌套字段',
                        type: 'string',
                        enum: '',
                        defVal: 'children',
                        emc: ''
                      },
                      {
                        keyName: 'checkStrictly',
                        desc: '在显示复选框的情况下,是否严格的遵循父子不互相关联的做法',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      },
                      {
                        keyName: 'labelFormat',
                        desc: '树节点渲染时显示内容格式化',
                        type: 'string',
                        enum: '',
                        defVal: '{code}-{name}',
                        emc: ''
                      }
                    ]
                  },
                  {
                    keyName: 'axiosConfig',
                    desc: '请求配置',
                    type: 'Object',
                    enum: '',
                    defVal: '',
                    emc: '',
                    children: [
                      {
                        keyName: 'rootName',
                        desc: '根节点名称',
                        type: 'string',
                        enum: '',
                        defVal: '',
                        emc: ''
                      },
                      {
                        keyName: 'dataField',
                        desc: 'reponse返回数据包的field',
                        type: 'string',
                        enum: '',
                        defVal: 'data',
                        emc: ''
                      },
                      {
                        keyName: 'successCode',
                        desc: 'reponse成功响应码',
                        type: 'string',
                        enum: '',
                        defVal: '200',
                        emc: ''
                      },
                      {
                        keyName: 'statusField',
                        desc: 'reponse响应码的filed',
                        type: 'string',
                        enum: '',
                        defVal: 'rscode',
                        emc: ''
                      },
                      {
                        keyName: 'method',
                        desc: '请求方式',
                        type: 'string',
                        enum: '',
                        defVal: 'post',
                        emc: ''
                      },
                      {
                        keyName: 'url',
                        desc: '请求接口url: 当此项有值时将会自动请求数据',
                        type: 'string',
                        enum: '',
                        defVal: '',
                        emc: ''
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            keyName: 'Slots',
            desc: '插槽',
            type: '',
            enum: '',
            defVal: '',
            emc: ''
          },
          {
            keyName: 'Events',
            desc: '事件',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'onNodeCheckChange',
                desc: '节点选中状态发生变化时的回调',
                type: '',
                enum: '',
                defVal: '{ node, checked, childrenChecked }, $event, treeContext',
                emc: ''
              },
              {
                keyName: 'onCheckChange',
                desc: '当复选框被点击的时候触发',
                type: '',
                enum: '',
                defVal: '{ obj, data }, $event, treeContext',
                emc: ''
              },
              {
                keyName: 'onNodeClick',
                desc: '非下拉树: 树节点是单选点击的时候触发',
                type: '',
                enum: '',
                defVal: '{ node, treeData }, $event, treeContext',
                emc: ''
              },
              {
                keyName: 'onNodeCheckClick',
                desc: '非下拉树: 树节点是多选点击的时候触发',
                type: '',
                enum: '',
                defVal: '{ node, nodes, treeData }, $event, treeContext',
                emc: ''
              },
              {
                keyName: 'onNodeClick',
                desc: '下拉树: 树节点是单选点击的时候触发',
                type: '',
                enum: '',
                defVal: '{ node, treeData, value, fieldName }, $event, treeContext',
                emc: ''
              },
              {
                keyName: 'onNodeCheckClick',
                desc: '下拉树: 树节点是多选点击的时候触发',
                type: '',
                enum: '',
                defVal: '{ node, nodes, treeData, value, fieldName }, $event, treeContext',
                emc: ''
              },
              {
                keyName: 'onTreeLoaded',
                desc: '树数据加载完成后触发',
                type: '',
                enum: '',
                defVal: '{ treeData, treeContext }, $event',
                emc: ''
              }
            ]
          },
          {
            keyName: 'Methods',
            desc: '方法',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'initTreeData',
                desc: '传入树数据或者请求数据后,加载树数据  传参数true触发,false不触发',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'treeOptionFn',
                desc: '获取el-tree对象',
                type: '',
                enum: '',
                defVal: 'treeContext',
                emc: ''
              },
              {
                keyName: '...',
                desc: '其它方法: 参考el-tree的Methods, 可以通过treeOptionFn获取el-tree实例后,直接使用el-tree的Methods方法',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              }
            ]
          }
        ]
      }
    }
  }
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
Expand Copy