Saltar al contenido
⌘K

ArdoFileTree

Ver como Markdown
En esta página
Esta referencia de la API se genera a partir de los comentarios de TypeScript en inglés. Los nombres, las firmas y los ejemplos corresponden al paquete publicado.

Static directory tree for documentation, written as a nested Markdown list.

Renders as a list with an accessible name, so it needs no client state. Folders and files get icons, and nested folders are connected by indentation guides.

import { ArdoFileTree } from "ardo/ui"

<ArdoFileTree>{children}</ArdoFileTree>

Props

NameTypeRequiredDescription
childrenReactNodeYesA nested Markdown list. An item is a folder when it has a nested list or its name ends with
/. Bold text highlights an entry, and text after — renders as a muted comment.
classNamestringNoAdditional CSS class.

Props type: ArdoFileTreeProps

Example

<FileTree>

- app/
  - routes/
    - index.mdx
  - **root.tsx** — the root layout
- package.json

</FileTree>