Jamdesk Documentation logo

Tree

Muestra jerarquías de archivos y carpetas con expansión/colapso interactivo y navegación por teclado. Ideal para documentar la estructura de proyectos.

Tree muestra jerarquías de archivos y carpetas con expansión/colapso interactivo y navegación completa por teclado. Está diseñado para documentar estructuras de proyectos, mostrar distribuciones de directorios o explicar dónde deben ir los archivos en una base de código.

Usa Tree cuando:

  • Muestres la estructura del proyecto en guías de inicio
  • Expliques la organización de archivos en tutoriales
  • Documentes la salida del CLI que muestra árboles de directorios
  • Ilustres dónde añadir archivos en guías de configuración

Uso

<Tree>
  <TreeFolder name="src" defaultOpen>
    <TreeFile name="index.ts" />
  </TreeFolder>
</Tree>

Tree básico

package.json
<Tree>
  <TreeFolder name="src" defaultOpen>
    <TreeFile name="index.ts" />
    <TreeFile name="config.ts" />
  </TreeFolder>
  <TreeFile name="package.json" />
</Tree>

Ejemplo de estructura de proyecto

Muestra a los lectores cómo se ve un proyecto después de la configuración:

Tree vs bloques de código

CaracterísticaTreeBloque de código
InteractivoSí (expandir/colapsar)No
Navegación por tecladoSoporte completoNo
Jerarquía visualIconos + sangríaSolo texto
Mejor paraDocumentaciónReferencias rápidas en línea

Usa Tree para la documentación principal de estructura. Usa bloques de código para referencias rápidas en línea como "crea src/index.ts".

El componente Tree admite navegación completa por teclado:

TeclaAcción
Arrow DownIr al siguiente elemento
Arrow UpIr al elemento anterior
Arrow RightExpandir carpeta o ir al primer hijo
Arrow LeftColapsar carpeta o ir al elemento padre
HomeIr al primer elemento
EndIr al último elemento visible
Enter / SpaceAlternar expansión/colapso de carpeta
Escribir caracteresSaltar al elemento coincidente

Props

TreeFolder

stringrequired

Nombre de la carpeta mostrado en el árbol.

booleandefault: false

Iniciar en estado expandido.

booleandefault: true

Si la carpeta puede alternarse.

TreeFile

stringrequired

Nombre del archivo mostrado en el árbol.

¿Qué sigue?

Descripción general de componentes

Explora todos los componentes disponibles

Conceptos básicos de MDX

Aprende a usar componentes en MDX