shelving/ui/docs/DocumentationPage.d.ts

Toolkit for using data in JavaScript.

import type { ReactNode } from "react";
import { type DocumentationElementProps } from "../../util/element.js";
import type { AbsolutePath } from "../../util/path.js";
interface DocumentationPageProps extends DocumentationElementProps {
    /** Site-root-relative path of this page — threaded down so child cards build correct hrefs. */
    readonly path: AbsolutePath;
}
/**
 * Page renderer for a `tree-documentation` element (also used for `tree-file` elements, whose props are a compatible subset).
 * - Renders title, signatures (one per overload), content, parameters, returns, throws, and examples.
 * - Child symbols are grouped by `kind` into card sections (Functions, Classes, Methods, Properties, …), each under its own heading.
 * - All sections are conditional — only render when they have entries.
 */
export declare function DocumentationPage({ path, title, name, kind, description, content, signatures, params, returns, throws, examples, children, }: DocumentationPageProps): ReactNode;
export {};