@usecross/docs 0.11.0 → 0.12.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as CodeBlockProps, D as DocSetMeta, a as DocsLayoutProps, b as DocContent, M as MarkdownProps, S as SidebarProps, T as TableOfContentsProps, c as DocsAppConfig } from './types-Qbhh2Ihz.js';
-export { N as NavItem, d as NavSection, e as SharedProps, f as TOCItem } from './types-Qbhh2Ihz.js';
+import { C as CodeBlockProps, D as DocSetMeta, a as DocsLayoutProps, b as DocContent, M as MarkdownProps, S as SidebarProps, T as TableOfContentsProps, A as APIPageProps, N as NavSection, G as GriffeModule, c as GriffeClass, d as GriffeFunction, e as GriffeDocstring, f as GriffeParameter, g as GriffeDocstringSection, h as DocsAppConfig } from './types-_anC1UJu.js';
+export { u as ClassDocProps, w as DocstringProps, F as FunctionDocProps, r as GriffeAttribute, p as GriffeDecorator, o as GriffeDocstringElement, m as GriffeDocstringSectionKind, n as GriffeExpression, l as GriffeKind, s as GriffeMember, q as GriffeObjectBase, t as ModuleDocProps, i as NavItem, P as ParameterTableProps, j as SharedProps, v as SignatureProps, k as TOCItem } from './types-_anC1UJu.js';
 import { ReactNode } from 'react';
 import { ClassValue } from 'clsx';
 import { HighlighterCore } from 'shiki/core';
@@ -155,11 +155,19 @@ declare namespace HomePage {
  */
 declare function Markdown({ content, components }: MarkdownProps): react_jsx_runtime.JSX.Element;
 
+interface ExtendedSidebarProps extends SidebarProps {
+    /** Use compact styling (smaller text) */
+    compact?: boolean;
+    /** Make sections collapsible */
+    collapsible?: boolean;
+    /** Collapse sections with more than N items by default */
+    collapseThreshold?: number;
+}
 /**
  * Documentation sidebar with section-based navigation.
- * In multi-docs mode, includes a dropdown selector at the top.
+ * Supports both docs and API navigation styles.
  */
-declare function Sidebar({ nav, currentPath, className, docSets, currentDocSet }: SidebarProps): react_jsx_runtime.JSX.Element;
+declare function Sidebar({ nav, currentPath, className, docSets, currentDocSet, compact, collapsible, collapseThreshold, }: ExtendedSidebarProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Table of contents component with scroll spy functionality.
@@ -201,6 +209,151 @@ interface ThemeToggleProps {
  */
 declare function ThemeToggle({ className, size }: ThemeToggleProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * Main API documentation page component.
+ *
+ * Renders API documentation with a separate sidebar navigation.
+ * Automatically handles different item types (modules, classes, functions).
+ *
+ * @example
+ * // In your pages configuration:
+ * createDocsApp({
+ *   pages: {
+ *     'api/APIPage': APIPage,
+ *     // ...
+ *   }
+ * })
+ */
+declare function APIPage({ apiData, currentItem, currentPath, currentModule, apiNav, prefix, logoUrl, logoInvertedUrl, footerLogoUrl, footerLogoInvertedUrl, githubUrl, navLinks, header, headerHeight, footer, }: APIPageProps): react_jsx_runtime.JSX.Element;
+
+interface APILayoutProps {
+    children: React.ReactNode;
+    title: string;
+    apiNav: NavSection[];
+    currentPath: string;
+    logoUrl?: string;
+    logoInvertedUrl?: string;
+    footerLogoUrl?: string;
+    footerLogoInvertedUrl?: string;
+    githubUrl?: string;
+    navLinks?: Array<{
+        label: string;
+        href: string;
+    }>;
+    /** Right sidebar content (e.g., table of contents) */
+    rightSidebar?: React.ReactNode;
+    /** Custom header component (replaces entire header). Can be a ReactNode or a function that receives mobile menu props. */
+    header?: React.ReactNode | ((props: {
+        mobileMenuOpen: boolean;
+        toggleMobileMenu: () => void;
+    }) => React.ReactNode);
+    /** Header height in pixels. Used to calculate content offset. Defaults to 64 (h-16). */
+    headerHeight?: number;
+    /** Custom footer component */
+    footer?: React.ReactNode;
+}
+/**
+ * Layout component for API documentation pages.
+ * Uses the shared Sidebar component with compact styling and collapsible sections.
+ */
+declare function APILayout({ children, title, apiNav, currentPath, logoUrl: propLogoUrl, logoInvertedUrl: propLogoInvertedUrl, footerLogoUrl: propFooterLogoUrl, footerLogoInvertedUrl: propFooterLogoInvertedUrl, githubUrl: propGithubUrl, navLinks: propNavLinks, rightSidebar, header, headerHeight: propHeaderHeight, footer, }: APILayoutProps): react_jsx_runtime.JSX.Element;
+
+interface ModuleDocProps {
+    module: GriffeModule;
+    /** URL prefix for links */
+    prefix?: string;
+    /** Show full module content or just summary */
+    showFull?: boolean;
+    /** Additional CSS class */
+    className?: string;
+    /** Override display path (e.g., for aliases to show alias name instead of target path) */
+    displayPath?: string;
+    /** GitHub repository URL for "Open in GitHub" links */
+    githubUrl?: string;
+}
+/**
+ * Renders documentation for a module including its classes, functions, and submodules.
+ */
+declare function ModuleDoc({ module, prefix, showFull, className, displayPath, githubUrl }: ModuleDocProps): react_jsx_runtime.JSX.Element;
+
+interface ClassDocProps {
+    cls: GriffeClass;
+    /** URL prefix for links */
+    prefix?: string;
+    /** Current path for breadcrumb */
+    currentPath?: string;
+    /** GitHub repo URL for source links */
+    githubUrl?: string;
+    /** Additional CSS class */
+    className?: string;
+    /** Override display path (e.g., for aliases to show alias name instead of target path) */
+    displayPath?: string;
+}
+/**
+ * Renders documentation for a class matching strawberry.rocks design.
+ * Includes: Title, Constructor, Methods (collapsible), Attributes, and footer.
+ */
+declare function ClassDoc({ cls, prefix: _prefix, currentPath: _currentPath, githubUrl, className, displayPath }: ClassDocProps): react_jsx_runtime.JSX.Element;
+
+interface FunctionDocProps {
+    fn: GriffeFunction;
+    /** Whether this is a method (inside a class) */
+    isMethod?: boolean;
+    /** Show function name as title */
+    showName?: boolean;
+    /** GitHub repo URL for source links */
+    githubUrl?: string;
+    /** Additional CSS class */
+    className?: string;
+    /** Override display path (e.g., for aliases to show alias name instead of target path) */
+    displayPath?: string;
+}
+/**
+ * Renders documentation for a function or method matching strawberry.rocks design.
+ */
+declare function FunctionDoc({ fn, isMethod, showName, githubUrl, className, displayPath }: FunctionDocProps): react_jsx_runtime.JSX.Element;
+
+interface SignatureProps {
+    fn: GriffeFunction;
+    /** Show full path or just function name */
+    showPath?: boolean;
+    /** Additional CSS class */
+    className?: string;
+}
+/**
+ * Renders a Python function/method signature with syntax highlighting.
+ * Uses dark background style matching strawberry.rocks.
+ */
+declare function Signature({ fn, showPath, className }: SignatureProps): react_jsx_runtime.JSX.Element;
+
+interface DocstringProps {
+    docstring: GriffeDocstring | undefined;
+    /** Show raw text instead of parsed sections */
+    raw?: boolean;
+    /** Only show the text/description part, skip parameters/returns/etc */
+    showOnlyText?: boolean;
+    /** Additional CSS class */
+    className?: string;
+}
+/**
+ * Renders a parsed docstring with sections for parameters, returns, raises, etc.
+ */
+declare function Docstring({ docstring, raw, showOnlyText, className }: DocstringProps): react_jsx_runtime.JSX.Element | null;
+
+interface ParameterTableProps {
+    parameters: GriffeParameter[];
+    /** Docstring sections for parameter descriptions */
+    docstringSections?: GriffeDocstringSection[];
+    /** Additional CSS class */
+    className?: string;
+}
+/**
+ * Renders a two-column parameter list matching strawberry.rocks design.
+ * Left column: parameter name badge
+ * Right column: description, type, and default value
+ */
+declare function ParameterTable({ parameters, docstringSections, className }: ParameterTableProps): react_jsx_runtime.JSX.Element | null;
+
 /**
  * Create and mount an Inertia.js documentation app.
  *
@@ -237,4 +390,4 @@ declare function configureHighlighter(options: {
     langs?: Promise<any>[];
 }): void;
 
-export { CodeBlock, CodeBlockProps, DocContent, DocSetMeta, DocSetSelector, DocsAppConfig, DocsLayout, DocsLayoutProps, DocsPage, EmojiConfetti, HomeCTA, type HomeFeature, HomeFeatureItem, type HomeFeatureItemProps, HomeFeatures, type HomeFeaturesProps, HomeFooter, HomeHeader, type HomeHeaderProps, HomeHero, HomePage, type HomePageContextValue, type HomePageProps, InlineCode, Markdown, MarkdownProps, MobileMenuButton, type ResolvedTheme, Sidebar, SidebarProps, TableOfContents, TableOfContentsProps, type Theme, ThemeProvider, ThemeToggle, cn, configureHighlighter, createDocsApp, getHighlighter, themeInitScript, useTheme };
+export { APILayout, APIPage, APIPageProps, ClassDoc, CodeBlock, CodeBlockProps, DocContent, DocSetMeta, DocSetSelector, DocsAppConfig, DocsLayout, DocsLayoutProps, DocsPage, Docstring, EmojiConfetti, FunctionDoc, GriffeClass, GriffeDocstring, GriffeDocstringSection, GriffeFunction, GriffeModule, GriffeParameter, HomeCTA, type HomeFeature, HomeFeatureItem, type HomeFeatureItemProps, HomeFeatures, type HomeFeaturesProps, HomeFooter, HomeHeader, type HomeHeaderProps, HomeHero, HomePage, type HomePageContextValue, type HomePageProps, InlineCode, Markdown, MarkdownProps, MobileMenuButton, ModuleDoc, NavSection, ParameterTable, type ResolvedTheme, Sidebar, SidebarProps, Signature, TableOfContents, TableOfContentsProps, type Theme, ThemeProvider, ThemeToggle, cn, configureHighlighter, createDocsApp, getHighlighter, themeInitScript, useTheme };