使用LWC自定义组件展示层级JSON数据为树形结构

本文将介绍如何在Lightning Web Components (LWC) 中，不依赖lightning-tree组件，而是通过自定义方式，将层级结构的JSON数据以树形结构展示在页面上。重点在于利用LWC的模板循环和递归渲染，结合JavaScript库，实现数据的动态展开和折叠，最终呈现一个美观且易于交互的树形视图。

在Salesforce Lightning Web Components (LWC) 中，有时我们需要将复杂的层级JSON数据以树形结构展示给用户，以便于浏览和操作。虽然Salesforce提供了lightning-tree组件，但在某些情况下，我们可能需要更灵活的定制化方案。本文将介绍一种不依赖lightning-tree组件，而是通过自定义组件和JavaScript库来实现树形结构展示的方法。

1. 数据准备

首先，我们需要准备好需要展示的JSON数据。例如：

[
{
"label": "Lauren Boyle",
"name": "Lauren Boyle",
"expanded": true,
"items": [
{
"label": "Banoth Srikanth",
"name": "Banoth Srikanth",
"expanded": true,
"items": [
{
"label": "Stella Pavlova",
"name": "Stella Pavlova",
"expanded": true,
"items": []
}
]
},
{
"label": "Srikanth",
"name": "Srikanth",
"expanded": true,
"items": []
}
]
}
]

这个JSON数据表示一个层级结构，每个节点都有label（显示文本）、name（唯一标识符）、expanded（是否展开）和items（子节点数组）属性。

2. LWC组件的创建

创建一个新的LWC组件，例如命名为customTree.

3. HTML模板 (customTree.html)

在HTML模板中，我们将使用template指令和递归方式来渲染树形结构。

<template>
<ul>
<template for:each={treeData} for:item="node">
<li key={node.name}>
<div class="tree-node">
<span onclick={toggleNode} data-name={node.name}>
{node.label}
<template if:true={node.items.length}>
({node.items.length})
</template>
</span>
</div>
<template if:true={node.expanded}>
<c-custom-tree tree-data={node.items}></c-custom-tree>
</template>
</li>
</template>
</ul>
</template>

在这个模板中：

• template for:each={treeData} for:item=”node”: 循环遍历treeData数组，treeData是JS文件传递过来的数据。
• li key={node.name}: 为每个列表项设置唯一的key，提升渲染效率。
• <div class=”tree-node”>: 包含节点信息的容器。
• <span onclick={toggleNode} data-name={node.name}>: 显示节点标签，并绑定toggleNode方法，用于展开/折叠节点。data-name属性用于传递节点名称。
• <template if:true={node.expanded}>: 根据expanded属性，决定是否显示子节点。
• <c-custom-tree tree-data={node.items}></c-custom-tree>: 递归调用自身组件，渲染子节点。

4. JavaScript控制器 (customTree.js)

在JavaScript控制器中，我们需要处理数据初始化和节点展开/折叠的逻辑。

import { LightningElement, api } from 'lwc';
export default class CustomTree extends LightningElement {
@api treeData = [];
toggleNode(event) {
const nodeName = event.target.dataset.name;
this.treeData = this.toggleExpanded(this.treeData, nodeName);
}
toggleExpanded(data, nodeName) {
return data.map(node => {
if (node.name === nodeName) {
return { ...node, expanded: !node.expanded };
} else if (node.items && node.items.length > 0) {
return { ...node, items: this.toggleExpanded(node.items, nodeName) };
}
return node;
});
}
}

在这个JavaScript控制器中：

• @api treeData = []: 定义一个公共属性treeData，用于接收父组件传递的JSON数据。
• toggleNode(event): 当节点被点击时触发，获取节点名称，并调用toggleExpanded方法更新treeData。
• toggleExpanded(data, nodeName): 递归遍历data数组，找到与nodeName匹配的节点，并切换其expanded属性。使用map方法确保返回一个新的数组，触发LWC的重新渲染。

5. CSS样式 (customTree.css)

添加一些CSS样式，使树形结构更美观。

.tree-node {
cursor: pointer;
padding: 5px;
}
.tree-node:hover {
background-color: #f2f2f2;
}
ul {
list-style-type: none;
padding-left: 20px;
}

6. 父组件的使用

在父组件中，导入customTree组件，并将JSON数据传递给它。

<template>
<c-custom-tree tree-data={jsonData}></c-custom-tree>
</template>

import { LightningElement } from 'lwc';
import jsonData from './data.json'; // 导入JSON数据
export default class ParentComponent extends LightningElement {
jsonData = jsonData;
}

创建一个名为data.json的文件，并将JSON数据放入其中。

7. 注意事项和总结

• 性能优化: 对于非常大的JSON数据，递归渲染可能会影响性能。可以考虑使用虚拟滚动或懒加载等技术进行优化。
• 错误处理: 在实际应用中，需要添加错误处理机制，例如处理JSON数据格式错误的情况。
• 可访问性: 确保树形结构具有良好的可访问性，例如使用ARIA属性来描述节点的状态。
• 样式定制: 可以根据需要自定义CSS样式，使树形结构更符合UI设计。

通过以上步骤，我们就可以在LWC中，不依赖lightning-tree组件，而是通过自定义方式，将层级结构的JSON数据以树形结构展示在页面上。这种方法提供了更高的灵活性和定制化能力，可以满足各种复杂的业务需求。