## Tree Muestra un conjunto de datos jerárquicos. ### Uso básico Estructura básica de árbol. :::demo ```html ``` ::: ### Seleccionable Usado para la selección de nodos. :::demo Este ejemplo también muestra como cargar los datos de forma asíncrona. ```html ``` ::: ### Nodos hoja en modo perezoso (lazy load) :::demo Los datos de un nodo no son cargados hasta que no es pinchado, así que el árbol no puede predecir si es una hoja. Por eso a cada nodo se le añade el botón de desplegar, y si el nodo es una hoja el botón desaparecerá al pinchar en él. También puede decirle al árbol que el nodo es una hoja de antemano, y así evita que muestre el botón de desplegar. ```html ``` ::: ### Checkbox desactivados El checkbox de un nodo se puede poner como desactivado. :::demo En el ejemplo, la propiedad `disabled` se declara en `defaultProps`, y algunos nodos se ponen como `disabled:true`. Los checkboxes correspondientes son desactivados y no se pueden pinchar. ```html ``` ::: ### Desplegado o seleccionado por defecto Los nodos pueden estar desplegados o seleccionados por defecto. :::demo Utilice `default-expanded-keys` y `default-checked-keys` para establecer los nodos desplegados y seleccionados respectivamente. Tenga en cuenta que para que funcione es necesario que tengan `node-key`. Su valor es el nombre de una clave en el objeto data, y el valor de la clave debe ser único en todo el árbol. ```html ``` ::: ### Seleccionando nodos :::demo Este ejemplo muestra como establecer y leer nodos seleccionados. Esto se puede hacer por nodos o por claves. Si lo hace por claves el atributo `node-key` es necesario. ```html
get by node get by key set by node set by key reset
``` ::: ### Contenido personalizado en los nodos El contenido de los nodos puede ser personalizado, así que puede añadir iconos y botones a su gusto. :::demo Hay dos maneras de personalizar la plantilla para los nodos de árbol: `render-content` y scoped slot. Utilice `render-content` para asignar una función de renderizado que devuelve el contenido del árbol de nodos. Mire la documentación de node para una introducción detallada a las funciones de renderizado. Si prefiere scoped slot, tendrá acceso a los `nodos` y `datos` en el ámbito de aplicación, representando el objeto TreeNode y los datos del nodo actual respectivamente. Tenga en cuenta que este ejemplo no puede ejecutarse en codepen.io ya que no soporta la sintaxis JSX. En un proyecto real `render-content` funcionará si las dependencias relevantes están configuradas correctamente. ```html

Using render-content

Using scoped slot

{{ node.label }} Append Delete
``` ::: ### Filtrado de nodos Los nodos del árbol se pueden filtrar. :::demo Invoque el método `filter` de la instancia de Tree para filtrar los nodos. Su parámetro es la palabra de filtrado. Tenga en cuenta que para que funcione es necesario `filter-node-method`, y su valor el método de filtrado. ```html ``` ::: ### Acordeón Solo puede ser expandido un nodo del mismo nivel a la vez. :::demo ```html ``` ::: ### Draggable Puede arrastrar y soltar nodos de Tree añadiendo un atributo `draggable` . :::demo ```html ``` ::: ### Atributos | Atributo | Descripción | Tipo | Valores aceptados | Por defecto | | --------------------- | ---------------------------------------- | --------------------------------- | ----------------- | ----------- | | data | Datos del árbol | array | — | — | | empty-text | Texto a mostrar cuando data es void | string | — | — | | node-key | Identificador único en todo el árbol para los nodos | string | — | — | | props | Opciones de configuración | object | — | — | | render-after-expand | si se mostrarán los nodos hijo sólo después de que se desglose por primera vez un nodo padre | boolean | — | true | | load | Método para cargar los datos de subárboles | function(node, resolve) | — | — | | render-content | Función de renderizado para los nodos | Function(h, { node, data, store } | — | — | | highlight-current | Si el nodo actual está resaltado | boolean | — | false | | default-expand-all | Expandir todos los nodos por defecto | boolean | — | false | | expand-on-click-node | Si expandir o contraer un nodo al pincharlo, si es false solo se hará al pinchar en la flecha | boolean | — | true | | check-on-click-node | si marcar o desmarcar el nodo al hacer clic en el. Si es `false`, el nodo sólo se puede marcar o desmarcar haciendo clic en la casilla de verificación. | boolean | — | false | | auto-expand-parent | Expandir un nodo padre si el hijo está seleccionado | boolean | — | true | | default-expanded-keys | Array de claves de los nodos expandidos inicialmente | array | — | — | | show-checkbox | Si un nodo es seleccionable | boolean | — | false | | check-strictly | El estado de selección de un nodo no afecta a sus padres o hijos, cuando `show-checkbox` es `true` | boolean | — | false | | default-checked-keys | Array con claves de los nodos seleccionados inicialmente | array | — | — | | current-node-key | la clave del nodo inicialmente seleccionado | string, number | — | — | | filter-node-method | Esta función se ejecutará en cada nodo cuando se use el método filtrar, si devuelve `false` el nodo se oculta | Function(value, data, node) | — | — | | accordion | Si solo un nodo de cada nivel puede expandirse a la vez | boolean | — | false | | indent | Indentación horizontal de los nodos en niveles adyacentes, en pixeles | number | — | 16 | | icon-class | Icono del nodo del árbol de cliente | string | - | - | | lazy | si se trata de un nodo de hoja lazy load, utilizado con el atributo `load` | boolean | — | false | | draggable | si se habilita la función de drag & drop en los nodos | boolean | — | false | | allow-drag | esta función se ejecutará antes de arrastrar un nodo. si devuelve `false`, el nodo no puede ser arrastrado. | Function(nodo) | — | — | | allow-drop | esta función se ejecutará al arrastrar y soltar un nodo. si devuelve false, el nodo arrastrando no se puede soltar en el nodo destino. `type` tiene tres valores posibles: 'prev' (insertar el nodo de arrastre antes del nodo de destino), 'inner' (insertar el nodo de arrastre en el nodo de destino) y 'next' (insertar el nodo de arrastre después del nodo de destino) | Function(Nodoquesearrastra, Nododestino, type) | — | — | ### props | Atributo | Descripción | Tipo | Valores aceptados | Por defecto | | -------- | ---------------------------------------- | ----------------------------- | ----------------- | ----------- | | label | Especifica que clave del objecto nodo se utilizará como label | string, function(data, node) | — | — | | children | Especifica que objeto del nodo se utiliza como subárbol | string | — | — | | isLeaf | Especifica si el nodo es una hoja, sólo funciona cuando lazy load está activado | boolean, function(datos, nodo) | — | — | ### Métodos `Tree` tiene los siguientes métodos, que devuelven el array de nodos seleccionados. | Método | Descripción | Parámetros | | ----------------- | ---------------------------------------- | ---------------------------------------- | | filter | Filtra los nodos del árbol, los nodos filtrados estarán ocultos | Acepta un parámetro que será usado como primer parámetro para filter-node-method | | updateKeyChildren | Asocia un nuevo dato al nodo, solo funciona si `node-key` está asignado | (key, data)Acepta dos parámetros: 1. clave del nodo 2. nuevo dato | | getCheckedNodes | si el nodo puede ser seleccionado (`show-checkbox` es `true`), devuelve el array de nodos actualmente seleccionada. | (leafOnly, includeHalfChecked) Acepta dos parámetros de tipo booleano: 1. El valor por defecto es `false`. Si el parámetro es `true`, sólo devuelve el array de subnodos actualmente seleccionado. 2. El valor por defecto es `false`. Si el parámetro es `true`, el valor de retorno contiene nodos halfchecked. | | setCheckedNodes | Establece algunos nodos como seleccionados, solo funciona cuando `node-key` está asignado | Un array de nodos a seleccionar | | getCheckedKeys | Si los nodos pueden ser seleccionados (`show-checkbox` es `true`), devuelve un array con las claves de los nodos seleccionados | (leafOnly) Acepta un booleano que por defecto es `false`. | | setCheckedKeys | Establece algunos nodos como seleccionados, solo si `node-key` está asignado | (keys, leafOnly) Acepta dos parametros: 1. un array de claves 2. un booleano cuyo valor por defecto es `false`. Si el parámetro es `true`, solo devuelve los nodos seleccionados | | setChecked | Establece si un nodo está seleccionado, solo funciona si `node-key` esta asignado | (key/data, checked, deep) Acepta tres parámetros: 1. la clave o dato del nodo a ser seleccionado 2. un booleano que indica si un nodo el nodo estará seleccionado 3. un booleanoque indica si se hará en profundidad | | getHalfCheckedNodes | Si el nodo puede ser seleccionado (`show-checkbox` es `true`), devuelve la mitad del array de nodos actualmente seleccionada. | - | | getHalfCheckedKeys | Si el nodo puede ser seleccionado (`show-checkbox` es `true`), devuelve la mitad del array de claves del nodo actualmente seleccionado. | - | | getCurrentKey | devuelve la clave del nodo resaltado actualmente (null si no hay ninguno) | — | | getCurrentNode | devuelve los datos del nodo de resaltado (nulo si no hay ningún nodo resaltado) | — | | setCurrentKey | establece el nodo resaltado por la clave, solo funciona si `node-key` está asignado | (key) la clave del nodo a ser resaltado. Si es `null`, cancela los nodos actualmente resaltados | | setCurrentNode | establece el nodo resaltado, solo funciona si `node-key` está asignado | (node) nodo a ser resaltado | | getNode | devuelve el nodo por el dato o la clave | (data) los datos o clave del nodo | | remove | elimina un nodo, solo funciona si `node-key` está asignado | (data) los datos del nodo o nodo a borrar | | append | añadir un nodo hijo a un nodo determinado del árbol | (data, parentNode) 1. los datos del nodo hijo que se añadirán 2. los datos del nodo padre, clave o nodo | | insertBefore | insertar un nodo antes de un nodo dado en el árbol | (data, refNode) 1. Datos del nodo que se insertarán 2. Datos del nodo de referencia, clave o nodo | | insertAfter | insertar un nodo después de un nodo dado en el árbol | (data, refNode) 1. Datos del nodo que se insertarán 2. Datos del nodo de referencia, clave o nodo | ### Eventos | Nombre del evento | Descripción | Parámetros | | ----------------- | ---------------------------------------- | ---------------------------------------- | | node-click | se lanza cuando un nodo es pinchado | tres parámetros: el objeto del nodo seleccionado, propiedad `node` de TreeNode y el TreeNode en si | | node-contextmenu | se lanza cuando en un nodo se hace clic con el botón derecho | cuatro parámetros: evento, el objeto nodo sobre el que se hizo clic, la propiedad `node` del TreeNode, el TreeNode en si mismo | | check-change | se lanza cuando el estado de selección del nodo cambia | tres parámetros: objeto nodo que se corresponde con el que ha cambiado, booleano que dice si esta seleccionado, booleano que dice si el nodo tiene hijos seleccionados | | check | se activa al hacer clic en la casilla de selección de un nodo | dos parámetros: objeto de nodo correspondiente al nodo que se marca/desmarca, objeto de estatus de árbol verificado que tiene cuatro puntales: checkedNodes, checkedKeys, halfCheckedNodes, halfCheckedKeys | | current-change | cambia cuando el nodo actual cambia | dos parámetros: objeto nodo que se corresponde al nodo actual y propiedad `node` del TreeNode | | node-expand | se lanza cuando el nodo actual se abre | tres parámetros: el objeto del nodo abierto, propiedad `node` de TreeNode y el TreeNode en si | | node-collapse | se lanza cuando el nodo actual se cierra | tres parámetros: el objeto del nodo cerrado, propiedad `node` de TreeNode y el TreeNode en si | | node-drag-start | se activa cuando se inicia el arrastre | dos parámetros: el objeto del nodo que se arrastrara, evento. | | node-drag-enter | se desencadena cuando el nodo de arrastre entra en otro nodo | tres parámetros: objeto del nodo que se arrastra, objeto del nodo en el que entra, evento. | | node-drag-leave | se desencadena cuando el nodo de arrastre sale de un nodo | tres parámetros: objeto del nodo que se arrastra, objeto del nodo del cual se sale, evento. | | node-drag-over | se activa cuando se arrastra sobre un nodo (como el evento mouseover) | tres parámetros: objeto del nodo que se arrastra, objeto del nodo sobre el que esta el arrastre, evento. | | node-drag-end | se activa cuando se termina de arrastrar | cuatro parámetros: objeto del nodo que se arrastra, objeto del nodo que corresponde al final del arrastre (puede ser `undefined` ), tipo de integración (antes (before), después (after), dentro (inner) ), evento. | | node-drop | después de soltar el nodo de arrastre | cuatro parámetros: objeto del nodo que se esta arrastrando, objeto del nodo sobre el que se esta soltando, tipo de integración (antes (before), después (after), dentro (inner) ), evento. | ### Scoped Slot | Nombre | Descripción | |------|--------| | — | Contenido personalizado para nodos de tree. El parámetro del scope es { node, data }. |