1.2.0 • Published 5 months ago
@atmgrupomaggioli/iris-tree v1.2.0
iris-tree
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
autoCollapse | auto-collapse | Propiedad booleana que determina si se quiere collapsar los nodos del mismo nivel cuando se abra uno nuevo . | boolean | false |
data (required) | data | JSON con la información del árbol. | NodeTree[] | undefined |
defaultIcon | default-icon | Establece un icono por defecto a los nodos que no dispongan de uno. | boolean | true |
lazyLoad | lazy-load | Función que se ejecuta en los nodos que tienen definido la clave 'lazy'. | (node: NodeTree) => NodeTree[] \| Promise<NodeTree[]> | undefined |
showCheckbox | show-checkbox | Propiedad booleana que determina si se debe mostrar un checkbox en cada nodo del árbol. | boolean | false |
Events
| Event | Description | Type |
|---|---|---|
nodeSelected | Se emite cuando se selecciona un nodo del árbol. | CustomEvent<NodeTreeInternal> |
ready | Evento lanzado cuando el componente está complementamente listo. | CustomEvent<void> |
Methods
getInternalNodes() => Promise<NodeTreeInternal[]>
Permite obtener todos los nodos internos.
Returns
Type: Promise<NodeTreeInternal[]>
Nodos internos.
getNodesByKey(key: string) => Promise<NodeTreeInternal[]>
Busca los nodos que tienen la clave indicada.
Parameters
| Name | Type | Description |
|---|---|---|
key | string | Clave por la que buscar |
Returns
Type: Promise<NodeTreeInternal[]>
Nodos que coinciden con la clave
initNode(node: NodeTree) => Promise<NodeTreeInternal>
Permite obtener todos los nodos internos.
Parameters
| Name | Type | Description |
|---|---|---|
node | NodeTree |
Returns
Type: Promise<NodeTreeInternal>
Nodos internos.
modifyNode(currentNode: NodeTreeInternal, newProperties: Partial<NodeTreeInternal>) => Promise<void>
Modifica un nodo del nav.
Parameters
| Name | Type | Description |
|---|---|---|
currentNode | NodeTreeInternal | Nodo a modificar |
newProperties | { privateKey?: string; loading?: boolean; children?: NodeTreeInternal[]; key?: string; title?: string; icon?: string; lazy?: boolean; selected?: boolean; expanded?: boolean; rightIcon?: RightIcon; extraData?: any; } | Nuevas propiedades del nodo |
Returns
Type: Promise<void>
Built with StencilJS