File

packages/components/eui-tree/eui-tree-helper.ts

Description

Utility class for navigating and querying hierarchical tree data structures. Provides methods to locate nodes by value, retrieve paths, and extract items from tree data. Supports custom identifier keys for flexible node matching across different tree schemas. Commonly used with eui-tree component for programmatic tree manipulation and node lookup.

Basic Usage

const treeData: TreeDataModel = [
  {
    node: { treeContentBlock: { id: '1', label: 'Root' } },
    children: [
      { node: { treeContentBlock: { id: '1.1', label: 'Child' } } }
    ]
  }
];

const helper = new EuiTreeHelper(treeData);

// Get path to a node by ID
const path = helper.getPath('1.1', 'node.treeContentBlock.id');
// Returns: '0.0'

// Get multiple paths
const paths = helper.getPaths(['1', '1.1'], 'node.treeContentBlock.id');
// Returns: ['0', '0.0']

// Get actual tree items
const items = helper.getItems(['1.1'], 'node.treeContentBlock.id');
// Returns: [TreeItemModel]

With Custom Identifier

// Tree with custom structure
const customTree = [
  { node: { customId: 'abc', label: 'Item' } }
];

const helper = new EuiTreeHelper(customTree);
const path = helper.getPath('abc', 'node.customId');

Accessibility

• Helper methods are synchronous and non-blocking
• No direct accessibility concerns (utility class)

Notes

• Path format uses dot notation: '0.2.1' (indices at each level)
• Supports deeply nested tree structures
• Deep equality comparison for complex value matching
• Identifier key uses dot notation for nested properties
• Returns null/empty array if no matches found