boltdocs 1.10.2 → 2.0.0

package/dist/client/index.d.ts

@@ -1,15 +1,17 @@
-import { B as BoltdocsConfig } from '../config-BsFQ-ErD.js';
-export { a as BoltdocsThemeConfig } from '../config-BsFQ-ErD.js';
-import { C as CreateBoltdocsAppOptions, a as ComponentRoute } from '../types-Dj-bfnC3.js';
+import { B as BoltdocsConfig } from '../config-CX4l-ZNp.js';
+export { a as BoltdocsThemeConfig } from '../config-CX4l-ZNp.js';
+import { a as CreateBoltdocsAppOptions, C as ComponentRoute, O as OnThisPageProps, S as SandboxOptions } from '../types-BuZWFT7r.js';
+export { L as LayoutProps, b as SandboxEmbedOptions, c as SandboxFile, d as SandboxFiles } from '../types-BuZWFT7r.js';
+export { u as useRoutes } from '../use-routes-BefRXY3v.js';
+import * as React$1 from 'react';
+import React__default, { Component, ReactNode, ErrorInfo } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React from 'react';
+export { Admonition, AdmonitionProps, Badge, BadgeProps, Button, ButtonProps, Card, CardProps, Cards, CardsProps, Caution, CodeBlock, ComponentPreview, ComponentPreviewProps, ComponentProps, ComponentPropsProps, CopyMarkdown, Danger, Field, FieldProps, FileTree, FileTreeProps, Image, ImageProps, Important, InfoBox, Link, LinkProps, List, ListProps, Note, Tab, TabProps, Table, TableProps, Tabs, TabsProps, Tip, Video, Warning } from './components/mdx/index.js';
 import 'vite';
+import 'class-variance-authority/types';
+import 'react-aria-components';
+import 'class-variance-authority';
 
-declare global {
-    interface ImportMeta {
-        env: Record<string, any>;
-    }
-}
 /**
  * Creates and mounts the Boltdocs documentation app.
  *
@@ -34,54 +36,82 @@ declare global {
 declare function createBoltdocsApp(options: CreateBoltdocsAppOptions): void;
 
 /**
- * The top navigation bar of the documentation site.
+ * Hook to access the Boltdocs configuration.
  */
-declare function Navbar({ config, routes, allRoutes, currentLocale, currentVersion, }: {
-    config: BoltdocsConfig;
-    routes?: ComponentRoute[];
-    allRoutes?: ComponentRoute[];
-    currentLocale?: string;
-    currentVersion?: string;
-}): react_jsx_runtime.JSX.Element;
+declare function useConfig(): BoltdocsConfig;
 
-interface RouteItem {
-    path: string;
-    title: string;
-    group?: string;
-    groupTitle?: string;
-    sidebarPosition?: number;
-    badge?: string | {
-        text: string;
-        expires?: string;
-    };
-    icon?: string;
-    tab?: string;
-    groupIcon?: string;
+type Theme = 'light' | 'dark';
+interface ThemeContextType {
+    theme: Theme;
+    toggleTheme: () => void;
+    setTheme: (theme: Theme) => void;
+}
+declare function useTheme(): ThemeContextType;
+
+type MdxComponentsType = Record<string, React__default.ComponentType<any>>;
+declare function useMdxComponents(): MdxComponentsType;
+
+/**
+ * Props shared by all layout slot components.
+ */
+interface SlotProps {
+    children?: React__default.ReactNode;
+    className?: string;
+    style?: React__default.CSSProperties;
 }
 /**
- * The sidebar navigation component.
- * Groups documentation routes logically based on the `group` property.
- * Highlights the active link based on the current URL path.
+ * Root layout shell. Renders a full-height flex column.
  *
- * @param routes - Array of all generated routes to be displayed
- * @param config - Global configuration (which can contain sidebar overrides)
+ * Usage:
+ * ```tsx
+ * <DocsLayout>
+ *   <Navbar />
+ *   <DocsLayout.Body>...</DocsLayout.Body>
+ * </DocsLayout>
+ * ```
+ */
+declare function DocsLayoutRoot({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Horizontal flex container for sidebar + content + toc.
  */
+declare function Body({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Main scrollable content area.
+ */
+declare function Content({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Content header row (breadcrumbs + copy markdown).
+ */
+declare function ContentHeader({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+/**
+ * Footer area inside the content section (page nav).
+ */
+declare function ContentFooter({ children, className, style }: SlotProps): react_jsx_runtime.JSX.Element;
+declare const DocsLayout: typeof DocsLayoutRoot & {
+    Body: typeof Body;
+    Content: typeof Content;
+    ContentHeader: typeof ContentHeader;
+    ContentFooter: typeof ContentFooter;
+};
+
+interface LayoutProps {
+    children: React.ReactNode;
+}
+/**
+ * The built-in default layout for Boltdocs.
+ * Users who create their own `layout.tsx` can import the same building blocks
+ * and rearrange, wrap, or replace any section.
+ */
+declare function DefaultLayout({ children }: LayoutProps): react_jsx_runtime.JSX.Element;
+
+declare function Navbar(): react_jsx_runtime.JSX.Element;
+
 declare function Sidebar({ routes, config, }: {
-    routes: RouteItem[];
+    routes: ComponentRoute[];
     config: BoltdocsConfig;
 }): react_jsx_runtime.JSX.Element;
 
-interface TocHeading {
-    id: string;
-    text: string;
-    level: number;
-}
-declare function OnThisPage({ headings, editLink, communityHelp, filePath, }: {
-    headings?: TocHeading[];
-    editLink?: string;
-    communityHelp?: string;
-    filePath?: string;
-}): react_jsx_runtime.JSX.Element | null;
+declare function OnThisPage({ headings: rawHeadings, editLink, communityHelp, filePath, }: OnThisPageProps): react_jsx_runtime.JSX.Element | null;
 
 interface HeadProps {
     siteTitle: string;
@@ -94,279 +124,89 @@ interface HeadProps {
 }
 declare function Head({ siteTitle, siteDescription, routes }: HeadProps): null;
 
-interface BreadcrumbsProps {
-    routes: ComponentRoute[];
-    config: BoltdocsConfig;
-}
-declare function Breadcrumbs({ routes, config }: BreadcrumbsProps): react_jsx_runtime.JSX.Element | null;
+declare function Breadcrumbs(): react_jsx_runtime.JSX.Element | null;
 
-interface ThemeLayoutProps {
-    config: BoltdocsConfig;
-    routes: ComponentRoute[];
-    children: React.ReactNode;
-    /** Custom navbar component (slots) */
-    navbar?: React.ReactNode;
-    /** Custom sidebar component (slots) */
-    sidebar?: React.ReactNode;
-    /** Custom table of contents (OnThisPage) component (slots) */
-    toc?: React.ReactNode;
-    /** Custom background component (slots) */
-    background?: React.ReactNode;
-    /** Custom head/metadata component (slots) */
-    head?: React.ReactNode;
-    /** Custom breadcrumbs component (slots) */
-    breadcrumbs?: React.ReactNode;
-    /** Custom class name for the root layout element */
-    className?: string;
-    /** Custom styles for the root layout element */
-    style?: React.CSSProperties;
-}
 /**
- * The main structural layout for documentation pages.
- * Integrates the Navbar, Sidebar, and OnThisPage components into a cohesive shell.
- * It also manages mobile interaction states like the sidebar overlay toggle.
- *
- * @param config - The global Boltdocs configuration object
- * @param routes - The array of available doc routes (used to render the sidebar)
- */
-declare function ThemeLayout({ config, routes, children, navbar, sidebar, toc, background, head, breadcrumbs, className, style, }: ThemeLayoutProps): react_jsx_runtime.JSX.Element;
-
-interface PlaygroundProps {
-    code?: string;
-    children?: string | React.ReactNode;
-    preview?: React.ReactNode;
-    scope?: Record<string, any>;
-    readonly?: boolean;
-    noInline?: boolean;
-}
-declare function Playground({ code: propsCode, children, preview, scope, readonly, noInline: forceNoInline, }: PlaygroundProps): react_jsx_runtime.JSX.Element;
-
-declare function NotFound(): react_jsx_runtime.JSX.Element;
-
-declare function Loading(): react_jsx_runtime.JSX.Element;
-
-interface CodeBlockProps {
-    children?: React.ReactNode;
-    className?: string;
-    [key: string]: any;
-}
-/**
- * A specialized wrapper for code snippets compiled from MDX blocks.
- * Provides syntax highlighting styling scaffolding and a "Copy to Clipboard" button.
- */
-declare function CodeBlock({ children, ...props }: CodeBlockProps): react_jsx_runtime.JSX.Element;
-
-interface VideoProps {
-    /** Video source URL */
-    src?: string;
-    /** Poster/thumbnail image URL */
-    poster?: string;
-    /** Alt text for accessibility */
-    alt?: string;
-    /** Show native video controls (default: true) */
-    controls?: boolean;
-    /** Preload strategy (default: 'none') */
-    preload?: string;
-    /** Children (e.g. <source> elements) */
-    children?: React.ReactNode;
-    /** Allow any additional HTML video attributes */
-    [key: string]: any;
-}
-/**
- * Optimized video component with lazy loading via IntersectionObserver.
- * The `<video>` element is only rendered once it enters the viewport,
- * preventing unnecessary network downloads on initial page load.
- *
- * Usage in MDX:
- * ```mdx
- * <video src="/demo.mp4" poster="/demo-thumb.jpg" />
- * ```
+ * Component to display the previous and next page navigation buttons.
  */
-declare function Video({ src, poster, alt, children, controls, preload, ...rest }: VideoProps): react_jsx_runtime.JSX.Element;
+declare function PageNav(): react_jsx_runtime.JSX.Element | null;
 
-type ButtonProps = React.AnchorHTMLAttributes<HTMLAnchorElement> & React.ButtonHTMLAttributes<HTMLButtonElement> & {
-    /** Visual variant */
-    variant?: "primary" | "secondary" | "outline" | "ghost";
-    /** Size */
-    size?: "sm" | "md" | "lg";
-    /** If provided, renders as a link */
-    href?: string;
-    children: React.ReactNode;
-};
 /**
- * A versatile button/link component for use in MDX pages and the home page.
+ * A reading progress bar component that tracks the scroll position
+ * within the Boltdocs content area.
  *
- * ```mdx
- * <Button variant="primary" href="/docs/getting-started">Get Started →</Button>
- * <Button variant="secondary" href="https://github.com">GitHub</Button>
- * ```
+ * It utilizes react-aria-components for accessibility and is fixed
+ * to the top of the viewport for a premium, non-intrusive UI experience.
  */
-declare function Button({ variant, size, href, children, className, ...rest }: ButtonProps): react_jsx_runtime.JSX.Element;
+declare function ProgressBar(): react_jsx_runtime.JSX.Element;
 
-interface BadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
-    /** Color variant */
-    variant?: "default" | "primary" | "success" | "warning" | "danger" | "info";
-    children: React.ReactNode;
+interface Props {
+    children?: ReactNode;
+    fallback?: ReactNode;
 }
-/**
- * Inline badge / pill for labels, statuses, or tags.
- *
- * ```mdx
- * <Badge variant="success">Stable</Badge>
- * <Badge variant="warning">Beta</Badge>
- * ```
- */
-declare function Badge({ variant, children, className, ...rest }: BadgeProps): react_jsx_runtime.JSX.Element;
-
-interface CardsProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Number of columns (defaults to 3) */
-    cols?: 1 | 2 | 3 | 4;
-    children: React.ReactNode;
+interface State {
+    hasError: boolean;
+    error?: Error;
 }
-/**
- * Grid wrapper for `<Card>` components.
- *
- * ```mdx
- * <Cards cols={3}>
- *   <Card title="Fast" icon="⚡">Instant HMR.</Card>
- *   <Card title="Simple" icon="📁">File-system routing.</Card>
- * </Cards>
- * ```
- */
-declare function Cards({ cols, children, className, ...rest }: CardsProps): react_jsx_runtime.JSX.Element;
-interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Card heading */
-    title?: string;
-    /** Emoji or icon string displayed above the title */
-    icon?: React.ReactNode;
-    /** If provided, the entire card becomes a link */
-    href?: string;
-    children?: React.ReactNode;
+declare class ErrorBoundary extends Component<Props, State> {
+    state: State;
+    static getDerivedStateFromError(error: Error): State;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
 }
-/**
- * Individual feature/info card.
- */
-declare function Card({ title, icon, href, children, className, ...rest }: CardProps): react_jsx_runtime.JSX.Element;
 
-interface TabProps {
-    /** The label shown in the tab bar */
-    label: string;
-    children: React.ReactNode;
-}
-/**
- * A single tab panel. Must be used inside `<Tabs>`.
- *
- * ```mdx
- * <Tab label="npm">npm install boltdocs</Tab>
- * ```
- */
-declare function Tab({ children }: TabProps): react_jsx_runtime.JSX.Element;
-interface TabsProps {
-    /** Which tab index is initially active (0-based, default 0) */
-    defaultIndex?: number;
-    children: React.ReactNode;
-}
+declare function NotFound(): react_jsx_runtime.JSX.Element;
+
 /**
- * Tab container that manages active state.
+ * A premium loading component that includes an SVG fill animation
+ * and a synchronized progress indicator.
  *
- * ```mdx
- * <Tabs>
- *   <Tab label="npm">npm install boltdocs</Tab>
- *   <Tab label="pnpm">pnpm add boltdocs</Tab>
- * </Tabs>
- * ```
+ * It features a glassmorphism container and a Bolt-style SVG logo
+ * with a dynamic fill effect.
  */
-declare function Tabs({ defaultIndex, children }: TabsProps): react_jsx_runtime.JSX.Element;
+declare function Loading(): react_jsx_runtime.JSX.Element;
 
-interface AdmonitionProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Admonition type — controls color and icon */
-    type?: "note" | "tip" | "info" | "warning" | "danger";
-    /** Override the default title */
-    title?: string;
-    children: React.ReactNode;
-}
 /**
- * Callout / admonition box for notes, warnings, etc.
- *
- * ```mdx
- * <Admonition type="warning" title="Breaking Change">
- *   This API has changed in v2.
- * </Admonition>
- * ```
+ * Helper to define a sandbox and get a URL for the CodeSandbox Define API.
+ * Uses the official SDK `getParameters` for proper LZ-string compression.
  */
-declare function Admonition({ type, title, children, className, ...rest }: AdmonitionProps): react_jsx_runtime.JSX.Element;
-declare const Note: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
-declare const Tip: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
-declare const Warning: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
-declare const Danger: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
-declare const InfoBox: (props: Omit<AdmonitionProps, "type">) => react_jsx_runtime.JSX.Element;
-
-interface ListProps extends React.HTMLAttributes<HTMLUListElement> {
-    /** Visual variant */
-    variant?: "checked" | "arrow" | "default";
-    children: React.ReactNode;
-}
+declare function defineSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
 /**
- * Enhanced list component with icon variants.
+ * CORE API: Open a CodeSandbox using a form POST to the Define API.
  *
- * ```mdx
- * <List variant="checked">
- *   <li>File-system routing</li>
- *   <li>MDX support</li>
- *   <li>Syntax highlighting</li>
- * </List>
- * ```
- */
-declare function List({ variant, children, className, ...rest }: ListProps): react_jsx_runtime.JSX.Element;
-
-interface FileTreeProps {
-    children: React.ReactNode;
-}
+ * Uses a hidden form + POST which avoids URL length limits and is the
+ * recommended approach from CodeSandbox documentation. The SDK's
+ * `getParameters` handles LZ-string compression internally.
+ */
+declare function openSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
 /**
- * FileTree component displays a customized, styled tree structure for markdown lists.
+ * Generate an embeddable iframe URL for a CodeSandbox.
+ *
+ * This gives you more control than `openSandbox` — you can embed the sandbox
+ * inline on the page rather than opening a new tab. The returned URL can be
+ * used as the `src` of an `<iframe>`.
  *
- * ```mdx
- * <FileTree>
- * - src/
- *   - index.ts
- *   - components/
- *     - Button.tsx
- * - package.json
- * </FileTree>
+ * @example
+ * ```tsx
+ * const url = embedSandbox({
+ *   files: { "index.js": { content: "console.log('hello')" } },
+ *   embed: { view: "editor", theme: "dark" },
+ * }).url;
+ * // url → "https://codesandbox.io/api/v1/sandboxes/define?parameters=…&embed=1&view=editor&theme=dark"
  * ```
  */
-declare function FileTree({ children }: FileTreeProps): react_jsx_runtime.JSX.Element;
-
-interface TableProps {
-    headers?: string[];
-    data?: (string | React.ReactNode)[][];
-    children?: React.ReactNode;
-    className?: string;
-    sortable?: boolean;
-    paginated?: boolean;
-    pageSize?: number;
-}
-declare function Table({ headers, data, children, className, sortable, paginated, pageSize, }: TableProps): react_jsx_runtime.JSX.Element;
-
-interface FieldProps {
-    /** The name of the property or field */
-    name: string;
-    /** The data type of the field (e.g., "string", "number", "boolean") */
-    type?: string;
-    /** The default value if not provided */
-    defaultValue?: string;
-    /** Whether the field is required */
-    required?: boolean;
-    /** Description or additional content */
-    children: React.ReactNode;
-    /** Optional anchor ID for linking */
-    id?: string;
-    /** Optional extra class name */
-    className?: string;
-}
-/**
- * A highly aesthetic and readable component for documenting API fields/properties.
- */
-declare function Field({ name, type, defaultValue, required, children, id, className, }: FieldProps): react_jsx_runtime.JSX.Element;
+declare function embedSandbox(options: SandboxOptions): {
+    parameters: string;
+    url: string;
+    options: SandboxOptions;
+};
 
-export { Admonition, type AdmonitionProps, Badge, type BadgeProps, BoltdocsConfig, Breadcrumbs, Button, type ButtonProps, Card, type CardProps, Cards, type CardsProps, CodeBlock, ComponentRoute, CreateBoltdocsAppOptions, Danger, Field, type FieldProps, FileTree, type FileTreeProps, Head, InfoBox, List, type ListProps, Loading, Navbar, NotFound, Note, OnThisPage, Playground, Sidebar, Tab, type TabProps, Table, type TableProps, Tabs, type TabsProps, ThemeLayout, Tip, Video, Warning, createBoltdocsApp };
+export { BoltdocsConfig, Breadcrumbs, ComponentRoute, CreateBoltdocsAppOptions, DefaultLayout, DocsLayout, ErrorBoundary, Head, Loading, Navbar, NotFound, OnThisPage, PageNav, ProgressBar, SandboxOptions, Sidebar, createBoltdocsApp, defineSandbox, embedSandbox, openSandbox, useConfig, useMdxComponents, useTheme };