TreeElementPropsinterface

{
	readonly name: string;
	readonly title?: string | undefined;
	readonly description?: string | undefined;
	readonly content?: string | undefined;
	readonly source?: AbsolutePath | undefined;
	readonly path?: AbsolutePath | undefined;
	readonly children?: TreeElements | undefined;
}
PropertyType
.namestring
The primary identifier shown in menus, cards, and other listings.
- Always set. For files this is the basename (e.g. "array" from array.ts); for directories it's the directory name;
for documented symbols it's the declared name (e.g. "getFirst").
- key is typically the slugified version of name. required readonly
.titlestring
Optional visual-only override for name, set only when a confident source is available
(e.g. a markdown <h1>, a docblock title).
- Renderers should fall back to name when title is missing. readonly
.descriptionstring
Short summary used for the page's <meta name="description"> tag — not rendered as visible page body.
- Pages plumb this through Meta.description; <Head> emits the meta tag.
- For visible body content (rendered inside the page) use content instead. readonly
.contentstring
Markup source string that should be rendered as the element's visible body content.
- Rendered via the <Markup> component (typically inside a <Prose> wrapper).
- For Markdown files this is the file's body (the title # h1 is lifted into title); for TypeScript symbols this is the JSDoc description. readonly
.sourceAbsolutePath
Source location for the element — the absolute filesystem path it was extracted from.
- For directories this is the directory path; for files this is the file path.
- Optional: synthesised elements (e.g. kind: "module" documentation) have no single source. readonly
.pathAbsolutePath
Canonical site-root-relative URL path of this element (e.g. "/schema/BooleanSchema"), stamped by flattenTree().
- This is the exact URL the element renders at, and the canonical key it's registered under in flattenTree().
- Absent on a freshly-extracted tree — paths are derived from tree structure when the tree is flattened, not at extraction. readonly
.childrenTreeElements
Children of a tree element must be other tree elements. readonly

Props for a tree element — must have a tree- prefixed type.