---
url: /docs/forms/components/tree.md
---
# Tree 组件

[ElementPlus tree 组件](https://element-plus.org/zh-CN/component/tree.html)

以下是去掉方法说明后面参数类型的中文文档，方法标题不使用反引号：

# 树型组件方法说明

### 设置内容为空时展示的文本

```php
$this->emptyText('暂无数据');
```

内容为空的时候展示的文本。

***

### 设置每个树节点的唯一标识属性

```php
$this->nodeKey('id');
```

每个树节点用来作为唯一标识的属性，整棵树应该是唯一的。

***

### 设置配置选项

```php
$this->props(['label' => 'name', 'children' => 'children']);
```

配置选项，具体看下表。

***

### 设置是否在第一次展开某个树节点后渲染其子节点

```php
$this->renderAfterExpand(true);
```

是否在第一次展开某个树节点后才渲染其子节点，默认值: true。

***

### 设置加载子树数据的方法

```php
$this->load(function ($node, $resolve) {
    // 加载子树数据的逻辑
});
```

加载子树数据的方法，仅当 lazy 属性为 true 时生效。

***

### 设置树节点内容区的渲染函数

```php
$this->renderContent(function ($h, $context) {
    // 自定义渲染逻辑
});
```

树节点的内容区的渲染函数。

***

### 设置是否高亮当前选中节点

```php
$this->highlightCurrent(true);
```

是否高亮当前选中节点，默认值: false。

***

### 设置是否默认展开所有节点

```php
$this->defaultExpandAll(true);
```

是否默认展开所有节点，默认值: false。

***

### 设置点击节点时的展开或收缩行为

```php
$this->expandOnClickNode(true);
```

是否在点击节点的时候展开或者收缩节点，默认值: true。

***

### 设置点击节点时的选中行为

```php
$this->checkOnClickNode(true);
```

是否在点击节点的时候选中节点，默认值: false。

***

### 设置展开子节点时是否自动展开父节点

```php
$this->autoExpandParent(true);
```

展开子节点的时候是否自动展开父节点，默认值: true。

***

### 设置默认展开的节点的 key 数组

```php
$this->defaultExpandedKeys(['key1', 'key2']);
```

默认展开的节点的 key 的数组。

***

### 设置节点是否可被选择

```php
$this->showCheckbox(true);
```

节点是否可被选择，默认值: false。

***

### 设置复选框的选中行为

```php
$this->checkStrictly(true);
```

在显示复选框的情况下，是否严格遵循父子不互相关联的做法，默认值: false。

***

### 设置默认勾选的节点的 key 数组

```php
$this->defaultCheckedKeys(['key1', 'key2']);
```

默认勾选的节点的 key 的数组。

***

### 设置当前选中的节点

```php
$this->currentNodeKey('selectedKey');
```

当前选中的节点。

***

对树节点进行筛选时执行的方法，返回 true 表示这个节点可以显示，返回 false 则表示这个节点会被隐藏。

***

### 设置是否每次只打开一个同级树节点展开

```php
$this->accordion(true);
```

是否每次只打开一个同级树节点展开，默认值: false。

***

### 设置相邻级节点间的水平缩进

```php
$this->indent(16);
```

相邻级节点间的水平缩进，单位为像素，默认值: 16。

***

### 设置自定义树节点的图标

```php
$this->iconClass('custom-icon');
```

自定义树节点的图标。

***

### 设置是否懒加载子节点

```php
$this->lazy(true);
```

是否懒加载子节点，需与 load 方法结合使用，默认值: false。

***

### 设置是否开启拖拽节点功能

```php
$this->draggable(true);
```

是否开启拖拽节点功能，默认值: false。