Descripción general del árbol Web Components

Ignite UI for Web Components Tree, también conocido como componente TreeView, es un control de alto rendimiento que visualiza estructuras de datos expandibles dentro de una UI en forma de árbol, lo que le permite aplicar carga bajo demanda para elementos secundarios. La Ignite UI for Web Components también proporciona funciones como expandir y contraer nodos, navegación de aplicaciones anidadas, los nodos del árbol Ignite UI for Web Components se pueden generar manualmente o desde una fuente de datos vinculada.

Para los usuarios finales, esto significa que pueden navegar fácilmente a través de diferentes páginas de aplicaciones, usar selecciones, casillas de verificación, agregar textos, íconos, imágenes y más.

El componente de árbol Ignite UI for Web Components permite a los usuarios representar datos jerárquicos en una estructura de vista de árbol, manteniendo las relaciones padre-hijo, así como definir una estructura de vista de árbol estática sin un modelo de datos correspondiente. Su objetivo principal es permitir a los usuarios finales visualizar y navegar dentro de estructuras de datos jerárquicas. El componente IgcTreeComponent también proporciona capacidades de carga bajo demanda, activación de elementos, selección múltiple y en cascada de elementos a través de casillas de verificación integradas, navegación con teclado integrado y más.

Web Components Tree Example

En este ejemplo básico de árbol Ignite UI for Web Components, puede ver cómo definir un árbol y sus elementos especificando la jerarquía de elementos.

How to Use Ignite UI for Web Components Tree With Ignite UI

Primero, debe instalar la Ignite UI for Web Components ejecutando el siguiente comando:

npm install igniteui-webcomponents

Antes de utilizar IgcTreeComponent, debe registrarlo de la siguiente manera:

import { defineComponents, IgcTreeComponent } from 'igniteui-webcomponents';
defineComponents(IgcTreeComponent);

Para obtener una introducción completa a Ignite UI for Web Components, lea el tema Introducción.

La forma más sencilla de empezar a utilizar IgcTreeComponent es la siguiente:

Declaring a tree

IgcTreeItemComponent es la representación de cada elemento que pertenece a la IgcTreeComponent. Los elementos proporcionan disabled, active, selected y expanded propiedades, que le dan la oportunidad de configurar los estados del elemento según sus requisitos. La value propiedad se puede utilizar para agregar una referencia a la entrada de datos que representa el elemento.

Los artículos se pueden declarar utilizando uno de los siguientes enfoques.

Declarar el árbol y sus elementos especificando la jerarquía de elementos e iterando a través de un conjunto de datos

<igc-tree>
    ${data.map((x) => html`
        <igc-tree-item .value=${x} .expanded=${x.expanded} .label=${x.label}>
              ${x.children.map((y) => html`
                  <igc-tree-item .value=${y} .expanded=${y.expanded}>
                      <span slot="label">${y.label}</slot>
                  </igc-tree-item>
              `
        </igc-tree-item>
    `
</igc-tree>

Los elementos se pueden vincular a un modelo de datos para que sus estados expandidos y seleccionados también se reflejen en los datos subyacentes.

Declarar un árbol creando elementos estáticos independientes

Para representar un árbol, no es necesario que se necesite un conjunto de datos: se pueden crear elementos individuales sin un modelo de datos subyacente mediante la propiedad expuesta label o proporcionar un contenido de ranura personalizado para la IgcTreeItemComponent etiqueta.

<igc-tree>
    <igc-tree-item>
        <div slot="label">
            I am a parent item 1
	        <img src="hard_coded_src.webb" alt="Alt Text">
        </div>
	    <igc-tree-item label="I am a child item 1">
	    </igc-tree-item>
    </igc-tree-item>

    <igc-tree-item>
        <div slot="label">
            I am a parent item 2
	        <img src="hard_coded_src.webb" alt="Alt Text">
        </div>
	    <igc-tree-item label="I am a child item 1">
	    </igc-tree-item>
    </igc-tree-item>
</igc-tree>

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

Item Interactions

IgcTreeItemComponent podría expandirse o contraerse:

haciendo clic en el elemento Indicador de expansión (comportamiento predeterminado).
Al hacer clic en el elemento si el IgcTreeComponent toggleNodeOnClick property se establece en true.

<igc-tree toggle-node-on-click="true">
    <igc-tree-item label="North America">
        <igc-tree-item label="United States"></igc-tree-item>
        <igc-tree-item label="Canada"></igc-tree-item>
        <igc-tree-item label="Mexico"></igc-tree-item>
    </igc-tree-item>
    <igc-tree-item label="South America">
        <igc-tree-item label="Brazil"></igc-tree-item>
    </igc-tree-item>
</igc-tree>

De forma predeterminada, se pueden expandir varios elementos al mismo tiempo. Para cambiar este comportamiento y permitir la expansión de una sola rama a la vez, se podría habilitar la singleBranchExpand propiedad. De esta manera, cuando se expande un elemento, se contraerán todas las demás ramas ya expandidas en el mismo nivel.

<igc-tree single-branch-expand="true">
    <igc-tree-item label="North America">
        <igc-tree-item label="United States"></igc-tree-item>
        <igc-tree-item label="Canada"></igc-tree-item>
        <igc-tree-item label="Mexico"></igc-tree-item>
    </igc-tree-item>
    <igc-tree-item label="South America">
        <igc-tree-item label="Brazil"></igc-tree-item>
    </igc-tree-item>
</igc-tree>

Además, proporciona IgcTreeComponent los siguientes métodos de API para las interacciones de elementos:

expand- Expande todos los elementos. Si se pasa una matriz items, expande solo los elementos especificados.
collapse- Contrae todos los elementos. Si se pasa una matriz items, contrae solo los elementos especificados.
select- Selecciona todos los elementos. Si se pasa una matriz items, selecciona solo los elementos especificados. No emite selection evento.
deselect- Anula la selección de todos los elementos. Si se pasa una matriz de elementos, anula la selección solo de los elementos especificados. No emite selection evento.

Web Components Tree Selection

Para configurar la selección de elementos en el componente Árbol de Ignite UI for Web Components, solo necesita establecer su selection propiedad. Esta propiedad acepta los tres modos siguientes: Ninguno, Múltiple y Cascada. A continuación echaremos un vistazo a cada uno de ellos con más detalle.

None

En IgcTreeComponent, la selección de elementos predeterminada está deshabilitada. Los usuarios no pueden seleccionar ni anular la selección de un elemento mediante la interacción de la interfaz de usuario, pero estas acciones aún se pueden completar mediante el método API proporcionado.

Multiple

Para habilitar la selección de varios elementos en el IgcTreeComponent simplemente establezca la selection propiedad en múltiples. Esto mostrará una casilla de verificación para cada elemento. Cada elemento tiene dos estados: seleccionado o no. Este modo admite la selección múltiple.

<igc-tree selection="multiple">
</igc-tree>

Cascade

Para habilitar la selección de elementos en cascada en IgcTreeComponent, simplemente establezca la propiedad de selección en cascada. Esto mostrará una casilla de verificación para cada elemento.

<igc-tree selection="Cascade">
</igc-tree>

En este modo, el estado de selección de un padre depende completamente del estado de selección de sus hijos. Cuando un padre tiene algunos hijos seleccionados y algunos no seleccionados, su casilla de verificación está en un estado indeterminado.

La navegación con el teclado en IgcTreeComponent proporciona una rica variedad de interacciones con el teclado para el usuario. Esta funcionalidad está habilitada de forma predeterminada y permite a los usuarios navegar a través de los elementos.

La navegación IgcTreeComponent cumple con los estándares de accesibilidad W3C y es fácil de usar.

Combinaciones de teclas

↓: navega al siguiente elemento visible. Marca el elemento como activo. No hace nada si está en el ÚLTIMO elemento.
Ctrl + ↓: navega al siguiente elemento visible. No hace nada si está en el ÚLTIMO elemento.
↑- navega al elemento visible anterior. Marca el elemento como activo. No hace nada si está en el PRIMER elemento.
Ctrl + ↑: navega al elemento visible anterior. No hace nada si está en el PRIMER elemento.
←: en un elemento principal expandido, lo contrae. Si el elemento está contraído o no tiene hijos, se mueve a su elemento principal. No hace nada si no hay ningún elemento principal.
→- en un elemento principal expandido, navega al primer elemento secundario del elemento. Si se encuentra en un elemento principal contraído, lo expande. No hace nada si el artículo no tiene hijos.
Inicio: navega al PRIMER elemento.
Fin: navega hasta el ÚLTIMO elemento visible.
Tabulador: navega al siguiente elemento enfocable de la página, fuera del árbol.
Mayús + Tabulador: navega al elemento enfocable anterior en la página, fuera del árbol.
Espacio: alterna la selección del elemento actual. Marca el nodo como activo.
Mayús + Espacio: alterna la selección de todos los elementos entre el activo y el espacio presionado mientras mantiene presionada la tecla Mayús si la selección está habilitada.
Enter: activa el elemento enfocado. Si el artículo tiene un enlace, abre el enlace.
*: expande el artículo y todos los artículos hermanos en el mismo nivel.

Cuando la selección está habilitada, la selección de elementos por parte del usuario final solo se permite a través de la casilla de verificación representada. Dado que ambos tipos de selección permiten selección múltiple, están disponibles las siguientes interacciones con el mouse y el teclado:

Hacer clic: cuando se realiza en la casilla de verificación del elemento, alterna la selección del elemento si la selección está habilitada. De lo contrario, enfoca el elemento.
Mayús + clic: cuando se realiza en la casilla de verificación del elemento, alterna la selección de todos los elementos entre el activo y el que se hizo clic mientras se mantiene presionada la tecla Mayús si la selección está habilitada.

Web Components Tree Load On Demand

La Ignite UI for Web Components se puede representar de tal manera que requiera recuperar la cantidad mínima de datos del servidor para que el usuario pueda verlos lo más rápido posible. Con este enfoque de carga dinámica de datos, solo después de que el usuario expanda un elemento, se recuperarán los elementos secundarios de ese elemento principal en particular. Este mecanismo, también conocido como Carga bajo demanda, se puede configurar fácilmente para funcionar con cualquier dato remoto.

Después de que el usuario hace clic en el icono de expansión, se reemplaza por un indicador de carga. Cuando la propiedad de carga se resuelve en falsa, el indicador de carga desaparece y se cargan los elementos secundarios.

Puede proporcionar un contenido de ranura personalizado para el área de carga utilizando la ranura loadingIndicator. Si dicha ranura no está definida, se utiliza IgcCircularProgressComponent.

Load On Demand With Virtualization

Cargar una mayor cantidad de elementos secundarios a pedido en la Ignite UI for Web Components podría afectar negativamente el rendimiento, ya que los elementos del árbol se definen de forma declarativa por diseño. La siguiente demostración muestra cómo se puede utilizar la biblioteca @lit-labs/virtualizer para representar los elementos del árbol secundario en un contenedor virtualizado. El resultado es un rendimiento mejorado, ya que solo la parte visible de los elementos secundarios se representa en el DOM.

Styling

Puede cambiar la apariencia de los IgcTreeItemComponent utilizando algunas de las partes CSS expuestas que se enumeran a continuación:

Nombre de la pieza	Descripción
`wrapper`	El contenedor del elemento del árbol.
`selected`	Indica el estado seleccionado. Se aplica a`wrapper`.
`focused`	Indica estado enfocado. Se aplica a`wrapper`.
`active`	Indica un estado activo. Se aplica a`wrapper`.
`indicator`	El indicador de expansión del elemento del árbol.
`label`	El contenido del elemento del árbol.
`text`	El elemento del árbol mostraba texto.
`select`	La casilla de verificación del elemento del árbol cuando la selección está habilitada.

Usando estas partes CSS podemos personalizar la apariencia del componente IgcTreeComponent de esta manera:

igc-tree-item::part(active) {
    background: #ecaa53;
}

igc-tree-item::part(selected) {
    background: #ffe6cc;
}

igc-tree-item::part(active selected) {
    background: #ff8c1a;
    color: white;
}