Jamdesk Documentation logo

Albero

Visualizza gerarchie di file e cartelle con espansione/compressione interattiva e navigazione da tastiera. Ideale per documentare la struttura dei progetti.

Tree mostra gerarchie di file e cartelle con espansione/compressione e navigazione da tastiera. Usalo per documentare strutture di progetto, layout di directory o la posizione dei file in una codebase.

Usa Tree quando:

  • Mostri la struttura del progetto nelle guide introduttive
  • Spieghi l'organizzazione dei file nei tutorial
  • Documenti l'output della CLI che mostra alberi di directory
  • Illustri dove aggiungere i file nelle guide di configurazione

Utilizzo

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

Albero di base

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

Esempio di struttura del progetto

Mostra ai lettori come appare un progetto dopo la configurazione:

Albero e blocchi di codice

CaratteristicaTreeBlocco di codice
InterattivoSì (espansione/compressione)No
Navigazione da tastieraSìNo
Gerarchia visivaIcone + indentazioneSolo testo
Ideale perDocumentazioneRiferimenti rapidi in linea

Usa Tree per la documentazione della struttura principale. Usa i blocchi di codice per riferimenti rapidi in linea come "crea src/index.ts".

Spostati nell'albero con questi tasti:

TastoAzione
Arrow DownPassa all'elemento successivo
Arrow UpPassa all'elemento precedente
Arrow RightEspandi la cartella o passa al primo figlio
Arrow LeftComprimi la cartella o passa al genitore
HomeVai al primo elemento
EndVai all'ultimo elemento visibile
Enter / SpaceAttiva/disattiva l'espansione della cartella
Caratteri digitatiVai all'elemento corrispondente

Proprietà

TreeFolder

stringrequired

Nome della cartella visualizzato nell'albero.

booleandefault: false

Inizia nello stato espanso.

booleandefault: true

Indica se la cartella può essere attivata/disattivata.

TreeFile

stringrequired

Nome del file visualizzato nell'albero.

Prossimi passi

Panoramica dei componenti

Sfoglia tutti i componenti disponibili

Nozioni base MDX

Scopri come usare i componenti in MDX