Árvore
Exiba hierarquias de arquivos e pastas com expandir/recolher interativo e navegação por teclado. Ideal para documentar a estrutura de projetos.
Tree exibe hierarquias de arquivos e pastas com expandir/recolher e navegação por teclado. Use-o para documentar estruturas de projetos, layouts de diretórios ou onde os arquivos ficam em uma base de código.
Use Tree quando:
- Mostrar a estrutura do projeto em guias de primeiros passos
- Explicar a organização de arquivos em tutoriais
- Documentar a saída da CLI que mostra árvores de diretórios
- Ilustrar onde adicionar arquivos em guias de configuração
Uso
<Tree>
<TreeFolder name="src" defaultOpen>
<TreeFile name="index.ts" />
</TreeFolder>
</Tree>
Árvore básica
src
package.json
<Tree>
<TreeFolder name="src" defaultOpen>
<TreeFile name="index.ts" />
<TreeFile name="config.ts" />
</TreeFolder>
<TreeFile name="package.json" />
</Tree>
Exemplo de estrutura de projeto
Mostre aos leitores como fica um projeto após a configuração:
my-app
Tree versus blocos de código
| Recurso | Tree | Bloco de código |
|---|---|---|
| Interativo | Sim (expandir/recolher) | Não |
| Navegação por teclado | Sim | Não |
| Hierarquia visual | Ícones + indentação | Somente texto |
| Melhor para | Documentação | Referências rápidas inline |
Use Tree para a documentação principal da estrutura. Use blocos de código para referências rápidas inline, como "crie src/index.ts".
Navegação pelo teclado
Percorra a árvore com estas teclas:
| Tecla | Ação |
|---|---|
Seta para baixo | Mover para o próximo item |
Seta para cima | Mover para o item anterior |
Seta para a direita | Expandir pasta ou mover para o primeiro filho |
Seta para a esquerda | Recolher pasta ou mover para o pai |
Home | Ir para o primeiro item |
End | Ir para o último item visível |
Enter / Space | Alternar expandir/recolher da pasta |
| Digitar caracteres | Ir para o item correspondente |
Props
TreeFolder
stringrequiredNome da pasta exibido na árvore.
booleandefault: falseInicia no estado expandido.
booleandefault: trueSe a pasta pode ser alternada.
TreeFile
stringrequiredNome do arquivo exibido na árvore.
