ArdoFileTree
Sur cette page
Cette référence API est générée à partir des commentaires TypeScript en anglais. Les noms, signatures et exemples correspondent au paquet publié.
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
| Name | Type | Required | Description |
|---|---|---|---|
children | ReactNode | Yes | A 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. |
className | string | No | Additional CSS class. |
Props type: ArdoFileTreeProps
Example
<FileTree>
- app/
- routes/
- index.mdx
- **root.tsx** — the root layout
- package.json
</FileTree>