Jamdesk Documentation logo

Á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

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:

Tree versus blocos de código

RecursoTreeBloco de código
InterativoSim (expandir/recolher)Não
Navegação por tecladoSimNão
Hierarquia visualÍcones + indentaçãoSomente texto
Melhor paraDocumentaçãoReferê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".

Percorra a árvore com estas teclas:

TeclaAção
Seta para baixoMover para o próximo item
Seta para cimaMover para o item anterior
Seta para a direitaExpandir pasta ou mover para o primeiro filho
Seta para a esquerdaRecolher pasta ou mover para o pai
HomeIr para o primeiro item
EndIr para o último item visível
Enter / SpaceAlternar expandir/recolher da pasta
Digitar caracteresIr para o item correspondente

Props

TreeFolder

stringrequired

Nome da pasta exibido na árvore.

booleandefault: false

Inicia no estado expandido.

booleandefault: true

Se a pasta pode ser alternada.

TreeFile

stringrequired

Nome do arquivo exibido na árvore.

O que vem a seguir?

Visão geral dos componentes

Veja todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX