React Tree Overview

Ignite UI for React Tree, also known as TreeView component, is a high-performance control that visualizes expandable data structures within a tree-like UI, enabling you to apply load on demand for child items. The Ignite UI for React Tree also provides features like expanding and collapsing nodes, nested app navigation, Ignite UI for React Tree nodes either can be generated manually or from a bound data source.

Para os usuários finais, isso significa que eles podem navegar facilmente por diferentes páginas do aplicativo, usar seleção, caixas de seleção, adicionar textos, ícones, imagens e muito mais.

The Ignite UI for React Tree component allows users to represent hierarchical data in a tree-view structure, maintaining parent-child relationships, as well as to define static tree-view structure without a corresponding data model. Its primary purpose is to allow end-users to visualize and navigate within hierarchical data structures. The IgrTree component also provides load on demand capabilities, item activation, multiple and cascade selection of items through built-in checkboxes, built-in keyboard navigation and more.

React Tree Example

In this basic Ignite UI for React Tree example, you can see how to define a tree and its items by specifying the item hierarchy.

How to Use Ignite UI for React Tree With Ignite UI

First, you need to the install the corresponding Ignite UI for React npm package by running the following command:

npm install igniteui-react

You will then need to import the IgrTree, its necessary CSS, and register its module, like so:

import { IgrTreeModule, IgrTree, IgrTreeItem } from 'igniteui-react';
import 'igniteui-webcomponents/themes/light/bootstrap.css';
IgrTreeModule.register();

The simplest way to start using the IgrTree is as follows:

Declaring a tree

IgrTreeItem is the representation of every item that belongs to the IgrTree. Items provide disabled, active, selected and expanded properties, which give you opportunity to configure the states of the item as per your requirement. The value property can be used to add a reference to the data entry the item represents.

Os itens podem ser vinculados a um modelo de dados para que seus estados expandidos e selecionados também sejam refletidos nos dados subjacentes.

Declarando uma árvore criando itens estáticos não vinculados

In order to render a tree you do not necessarily need a data set - individual items can be created without an underlying data model using the exposed label property or provide a custom slot content for the IgrTreeItem label.

<IgrTree>
    <IgrTreeItem label='North America'>
        <IgrTreeItem label='United States' />
        <IgrTreeItem label='Canada' />
        <IgrTreeItem label='Mexico' />
    </IgrTreeItem>
    <IgrTreeItem label='South America'>
        <IgrTreeItem label='Brazil' />
        <IgrTreeItem label='Uruguay' />
    </IgrTreeItem>
    <IgrTreeItem label='Europe'>
        <IgrTreeItem label='United Kingdom' />
        <IgrTreeItem label='Germany' />
        <IgrTreeItem label='Bulgaria' />
    </IgrTreeItem>
</IgrTree>

[!Note] You can provide a custom slot content for each IgrTreeItem's indentation, expansion and label area respectively using the provided indentation, indicator and label slots.

Item Interactions

IgrTreeItem could be expanded or collapsed:

clicando no indicador de expansão do item (comportamento padrão).
by clicking on the item if the IgrTree toggleNodeOnClick property is set to true.

Por padrão, vários itens podem ser expandidos ao mesmo tempo. Para alterar esse comportamento e permitir a expansão de apenas uma ramificação por vez, a propriedade singleBranchExpand pode ser habilitada. Dessa forma, quando um item é expandido, todas as outras ramificações já expandidas no mesmo nível serão recolhidas.

React Tree Selection

In order to setup item selection in the Ignite UI for React Tree component, you just need to set its selection property. This property accepts the following three modes: None, Multiple and Cascade. Below we will take a look at each of them in more detail.

None

In the IgrTree by default item selection is disabled. Users cannot select or deselect an item through UI interaction, but these actions can still be completed through the provided API method.

Multiple

To enable multiple item selection in the IgrTree just set the selection property to multiple. This will render a checkbox for every item. Each item has two states - selected or not. This mode supports multiple selection.

<IgrTree selection="multiple" />

Cascade

To enable cascade item selection in the IgrTree, just set the selection property to cascade. This will render a checkbox for every item.

<IgrTree selection="cascade" />

Nesse modo, o estado de seleção de um pai depende inteiramente do estado de seleção de seus filhos. Quando um pai tem alguns filhos selecionados e alguns desmarcados, sua caixa de seleção está em um estado indeterminado.

Keyboard navigation in IgrTree provides a rich variety of keyboard interactions for the user. This functionality is enabled by default and allows users to navigate through the items.

The IgrTree navigation is compliant with W3C accessibility standards and convenient to use.

Combinações de teclas

↓- navega para o próximo item visível. Marca o item como ativo. Não faz nada se estiver no ÚLTIMO item.
Ctrl + ↓- navega para o próximo item visível. Não faz nada se estiver no ÚLTIMO item.
↑- navega para o item visível anterior. Marca o item como ativo. Não faz nada se estiver no PRIMEIRO item.
Ctrl + ↑- navega para o item visível anterior. Não faz nada se estiver no PRIMEIRO item.
←- em um item pai expandido, o recolhe. Se o item estiver recolhido ou não tiver filhos, move para seu item pai. Não faz nada se não houver um item pai.
→- em um item pai expandido, navega para o primeiro filho do item. Se em um item pai recolhido, expande-o. Não faz nada se o item não tiver filhos.
Início- navega para o PRIMEIRO item.
Fim- navega até o ÚLTIMO item visível.
Tab- navega para o próximo elemento focalizável na página, fora da árvore.
Shift + Tab- navega para o elemento focalizável anterior na página, fora da árvore.
Espaço- alterna a seleção do item atual. Marca o nó como ativo.
Shift + Espaço- alterna a seleção de todos os itens entre o ativo e o pressionado. Espaço enquanto segura Shift se a seleção estiver habilitada.
Enter- ativa o item em foco. Se o item tiver um link, abre o link.
*- expande o item e todos os itens irmãos no mesmo nível.

Quando a seleção está habilitada, a seleção de itens pelo usuário final só é permitida por meio da caixa de seleção renderizada. Como ambos os tipos de seleção permitem seleção múltipla, as seguintes interações de mouse e teclado estão disponíveis:

Clique- quando executado na caixa de seleção do item, alterna a seleção do item se a seleção estiver habilitada. Caso contrário, foca o item
Shift + Clique- quando executado na caixa de seleção do item, alterna a seleção de todos os itens entre o ativo e o clicado enquanto mantém Shift pressionado se a seleção estiver habilitada

Styling

You can change the appearance of the IgrTreeItem, by using some of the exposed CSS parts listed below:

Nome da peça	Descrição
`wrapper`	O invólucro para o item da árvore.
`selected`	Indica o estado selecionado. Aplica-se a`wrapper`.
`focused`	Indica estado focado. Aplica-se a`wrapper`.
`active`	Indica um estado ativo. Aplica-se a`wrapper`.
`indicator`	O indicador de expansão do item da árvore.
`label`	O conteúdo do item da árvore.
`text`	O item da árvore exibia texto.
`select`	A caixa de seleção do item da árvore quando a seleção está habilitada.

Using these CSS parts we can customize thе appearance of the IgrTree component like this:

igc-tree-item::part(active) {
  background: var(--ig-secondary-500);
  color: var(--ig-secondary-500-contrast);
}