@geenius/docs 0.5.0 → 0.9.0

package/packages/react/dist/index.d.ts

@@ -1,16 +1,17 @@
-import { BreadcrumbItem, DocPage as DocPage$1, SearchResult, DocSection, TocItem, DocsConfig } from '@geenius/docs-shared';
-export { BreadcrumbItem, DocAccess, DocPage as DocPageType, DocSection, DocStatus, DocsConfig, SearchResult, TocItem } from '@geenius/docs-shared';
+import { BreadcrumbItem, DocPage as DocPage$1, SearchResult, DocSection, TocItem, DocsConfig } from '@geenius/docs/shared';
+export { BreadcrumbItem, DocAccess, DocPage as DocPageType, DocSection, DocStatus, DocsConfig, SearchResult, TocItem } from '@geenius/docs/shared';
 import React$1 from 'react';
 
 /**
  * @module reactBreadcrumbs
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders breadcrumb navigation for the React docs variant using
  * the shared docs route metadata and Tailwind styling contract.
  */
 
 interface BreadcrumbsProps {
     items: BreadcrumbItem[];
+    className?: string;
 }
 /**
  * Renders the current docs breadcrumb trail.
@@ -18,11 +19,11 @@ interface BreadcrumbsProps {
  * @param props - Breadcrumb items describing the current page ancestry.
  * @returns Breadcrumb navigation or `null` when there are no items to show.
  */
-declare function Breadcrumbs({ items, }: BreadcrumbsProps): React$1.JSX.Element | null;
+declare function Breadcrumbs({ items, className, }: BreadcrumbsProps): React$1.JSX.Element | null;
 
 /**
  * @module reactDocPage
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders a docs page body with safe Markdown semantics, heading
  * anchors, and package-consistent typography. The component deliberately avoids
  * raw HTML injection so authored docs content stays within the Markdown runtime.
@@ -30,6 +31,7 @@ declare function Breadcrumbs({ items, }: BreadcrumbsProps): React$1.JSX.Element
 
 interface DocPageProps {
     page: DocPage$1;
+    className?: string;
 }
 /**
  * Renders a docs page body using safe Markdown rendering.
@@ -41,7 +43,7 @@ declare function DocPage(props: DocPageProps): React$1.JSX.Element;
 
 /**
  * @module reactDocSearch
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Provides the React command-palette style docs search modal with
  * animated presentation, keyboard navigation, and result highlighting.
  */
@@ -53,6 +55,7 @@ interface DocSearchProps {
     onSelect: (result: SearchResult) => void;
     isOpen: boolean;
     onClose: () => void;
+    className?: string;
 }
 /**
  * Renders the modal search surface for the React docs variant.
@@ -60,22 +63,42 @@ interface DocSearchProps {
  * @param props - Search results, query state, and modal interaction handlers.
  * @returns Search dialog markup when open, otherwise `null`.
  */
-declare function DocSearch({ results, query, onQuery, onSelect, isOpen, onClose, }: DocSearchProps): React$1.JSX.Element | null;
+declare function DocSearch({ results, query, onQuery, onSelect, isOpen, onClose, className, }: DocSearchProps): React$1.JSX.Element | null;
+
+/**
+ * @module docsReactTypes
+ * @package @geenius/docs/react
+ * @description Declares the React-specific supporting types that keep the
+ * exported docs components aligned on shared section/page shapes and a common
+ * optional `className` extension point.
+ */
+
+/**
+ * Optional `className` contract shared by React docs exports.
+ */
+interface WithClassName {
+    className?: string;
+}
+/**
+ * Shared docs section shape used by layout, navigation, and page components.
+ */
+type DocsSectionWithPages = DocSection & {
+    pages?: DocPage$1[];
+    pageCount?: number;
+};
 
 /**
  * @module reactDocSidebar
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders the hierarchical sidebar navigation used by the React
  * docs variant, including animated section expansion and active page states.
  */
 
 interface DocSidebarProps {
-    sections: (DocSection & {
-        pages?: DocPage$1[];
-        pageCount?: number;
-    })[];
+    sections: DocsSectionWithPages[];
     currentPageId?: string;
     onNavigate: (page: DocPage$1, section: DocSection) => void;
+    className?: string;
 }
 /**
  * Sidebar navigation for docs sections and pages.
@@ -83,19 +106,17 @@ interface DocSidebarProps {
  * @param props - Section tree, active page id, and page navigation callback.
  * @returns Sidebar markup for the React docs experience.
  */
-declare function DocSidebar({ sections, currentPageId, onNavigate, }: DocSidebarProps): React.JSX.Element;
+declare function DocSidebar({ sections, currentPageId, onNavigate, className, }: DocSidebarProps): React.JSX.Element;
 
 /**
  * @module reactDocsLayout
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Composes the React docs page shell with sidebar navigation,
  * breadcrumb chrome, animated content transitions, and the right-rail TOC.
  */
 
 interface DocsLayoutProps {
-    sections: (DocSection & {
-        pages?: DocPage$1[];
-    })[];
+    sections: DocsSectionWithPages[];
     currentPage?: DocPage$1;
     toc?: TocItem[];
     activeHeadingId?: string;
@@ -103,6 +124,7 @@ interface DocsLayoutProps {
     currentPageId?: string;
     onNavigate: (page: DocPage$1, section: DocSection) => void;
     children: React$1.ReactNode;
+    className?: string;
 }
 /**
  * Layout shell shared by React docs pages.
@@ -110,17 +132,12 @@ interface DocsLayoutProps {
  * @param props - Navigation state, table-of-contents state, and page content.
  * @returns Full page layout for React docs screens.
  */
-declare function DocsLayout({ sections, toc, activeHeadingId, breadcrumbs, currentPageId, onNavigate, children, }: DocsLayoutProps): React$1.JSX.Element;
+declare function DocsLayout({ sections, toc, activeHeadingId, breadcrumbs, currentPageId, onNavigate, children, className, }: DocsLayoutProps): React$1.JSX.Element;
 
-/**
- * @module reactEditButton
- * @package @geenius/docs-react
- * @description Exposes the React docs "Edit this page" affordance so hosts can
- * route readers to the source repository for the active document.
- */
 interface EditButtonProps {
     pageSlug: string;
     editUrl?: string;
+    className?: string;
 }
 /**
  * Renders the source-edit link for the current docs page.
@@ -128,14 +145,8 @@ interface EditButtonProps {
  * @param props - Page slug and optional edit URL base.
  * @returns Edit link markup or `null` when editing is disabled.
  */
-declare function EditButton({ pageSlug, editUrl, }: EditButtonProps): React.JSX.Element | null;
+declare function EditButton({ pageSlug, editUrl, className, }: EditButtonProps): React.JSX.Element | null;
 
-/**
- * @module reactPageNavigation
- * @package @geenius/docs-react
- * @description Renders previous and next article affordances for the React
- * docs variant using the shared page navigation contract.
- */
 interface PageNavigationProps {
     prev?: {
         title: string;
@@ -145,6 +156,7 @@ interface PageNavigationProps {
         title: string;
         href: string;
     };
+    className?: string;
 }
 /**
  * Renders previous and next page links for the active article.
@@ -152,11 +164,11 @@ interface PageNavigationProps {
  * @param props - Optional previous and next navigation links.
  * @returns Navigation markup or `null` when no links are available.
  */
-declare function PageNavigation({ prev, next, }: PageNavigationProps): React.JSX.Element | null;
+declare function PageNavigation({ prev, next, className, }: PageNavigationProps): React.JSX.Element | null;
 
 /**
  * @module reactTableOfContents
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders the React docs table of contents with animated active
  * heading states and nested anchor links derived from the shared TOC model.
  */
@@ -164,6 +176,7 @@ declare function PageNavigation({ prev, next, }: PageNavigationProps): React.JSX
 interface TableOfContentsProps {
     toc: TocItem[];
     activeId?: string;
+    className?: string;
 }
 /**
  * Renders the page table of contents.
@@ -171,11 +184,11 @@ interface TableOfContentsProps {
  * @param props - TOC entries and the currently active heading id.
  * @returns TOC navigation or `null` when the page has no headings.
  */
-declare function TableOfContents({ toc, activeId, }: TableOfContentsProps): React.JSX.Element | null;
+declare function TableOfContents({ toc, activeId, className, }: TableOfContentsProps): React.JSX.Element | null;
 
 /**
  * @module reactVersionSelector
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Provides the React docs version switcher with a disclosure menu
  * for choosing among published documentation versions.
  */
@@ -183,6 +196,7 @@ interface VersionSelectorProps {
     versions: string[];
     current: string;
     onSelect: (version: string) => void;
+    className?: string;
 }
 /**
  * Renders a version switcher when multiple docs versions exist.
@@ -190,11 +204,11 @@ interface VersionSelectorProps {
  * @param props - Supported versions, the current version, and selection callback.
  * @returns Version selector markup or `null` when only one version exists.
  */
-declare function VersionSelector({ versions, current, onSelect, }: VersionSelectorProps): React.JSX.Element | null;
+declare function VersionSelector({ versions, current, onSelect, className, }: VersionSelectorProps): React.JSX.Element | null;
 
 /**
  * @module reactUseDocSearch
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Implements debounced search state for the React docs variant so
  * modal and page-level search flows share a common query lifecycle.
  */
@@ -220,7 +234,7 @@ declare function useDocSearch(searchFn: (query: string) => SearchResult[] | Prom
 
 /**
  * @module reactUseDocs
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Provides the core React docs state container that normalizes
  * section trees, current page selection, search state, and merged config.
  */
@@ -257,7 +271,7 @@ declare function useDocs(tree: (DocSection & {
 
 /**
  * @module reactUseDocsAdmin
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Wraps docs admin mutations in stable React callbacks so the
  * admin pages can manage sections and pages without coupling to one backend.
  */
@@ -323,7 +337,7 @@ declare function useDocsAdmin(mutations: {
 
 /**
  * @module reactUseTableOfContents
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Tracks the extracted table of contents and active heading state
  * for rendered React docs pages.
  */
@@ -346,7 +360,7 @@ declare function useTableOfContents(mdxContent: string | undefined): TableOfCont
 
 /**
  * @module reactDocSearchPage
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders the dedicated React docs search page with a full-page
  * query input, ranked search results, and empty-state messaging.
  */
@@ -357,6 +371,7 @@ interface DocSearchPageProps {
         pageCount: number;
     })[] | undefined;
     onSelectPage?: (page: DocPage$1, section: DocSection) => void;
+    className?: string;
 }
 /**
  * Dedicated search page for the React docs variant.
@@ -364,11 +379,11 @@ interface DocSearchPageProps {
  * @param props - Docs tree and optional page selection handler.
  * @returns Search page UI or a loading state when the tree is unresolved.
  */
-declare function DocSearchPage({ tree, onSelectPage, }: DocSearchPageProps): React.JSX.Element;
+declare function DocSearchPage({ tree, onSelectPage, className, }: DocSearchPageProps): React.JSX.Element;
 
 /**
  * @module reactDocsAdminPage
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders the React docs admin surface for creating, updating,
  * publishing, and deleting docs sections and pages.
  */
@@ -380,6 +395,7 @@ interface DocsAdminPageProps {
     })[] | undefined;
     allPages?: DocPage$1[];
     admin: DocsAdminActions;
+    className?: string;
 }
 /**
  * Admin page for section and page management in the React docs variant.
@@ -387,11 +403,11 @@ interface DocsAdminPageProps {
  * @param props - Tree data, optional page list, and admin actions.
  * @returns Admin UI for managing docs content.
  */
-declare function DocsAdminPage({ tree, allPages, admin, }: DocsAdminPageProps): React.JSX.Element;
+declare function DocsAdminPage({ tree, allPages, admin, className, }: DocsAdminPageProps): React.JSX.Element;
 
 /**
  * @module reactDocsIndexPage
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders the React docs landing page with section discovery,
  * recent updates, and command-palette search entry points.
  */
@@ -402,6 +418,7 @@ interface DocsIndexPageProps {
         pageCount: number;
     })[] | undefined;
     onSelectPage?: (page: DocPage$1, section: DocSection) => void;
+    className?: string;
 }
 /**
  * Landing page for the React docs experience.
@@ -409,11 +426,11 @@ interface DocsIndexPageProps {
  * @param props - Docs tree plus optional page selection handler.
  * @returns Landing page UI for the React docs variant.
  */
-declare function DocsIndexPage({ tree, onSelectPage, }: DocsIndexPageProps): React.JSX.Element;
+declare function DocsIndexPage({ tree, onSelectPage, className, }: DocsIndexPageProps): React.JSX.Element;
 
 /**
  * @module reactDocViewPage
- * @package @geenius/docs-react
+ * @package @geenius/docs/react
  * @description Renders the primary React docs article page with layout chrome,
  * metadata, TOC tracking, edit actions, and previous or next navigation.
  */
@@ -427,6 +444,7 @@ interface DocViewPageProps {
     editPageUrl?: string;
     onNavigate: (page: DocPage$1, section: DocSection) => void;
     onIncrementView?: (pageId: string) => void;
+    className?: string;
 }
 /**
  * Detailed article page for the React docs variant.
@@ -434,6 +452,6 @@ interface DocViewPageProps {
  * @param props - Docs tree, active page, and page-level interaction handlers.
  * @returns Detailed page view or an appropriate loading or empty state.
  */
-declare function DocViewPage({ tree, page, editPageUrl, onNavigate, onIncrementView, }: DocViewPageProps): React.JSX.Element;
+declare function DocViewPage({ tree, page, editPageUrl, onNavigate, onIncrementView, className, }: DocViewPageProps): React.JSX.Element;
 
-export { Breadcrumbs, DocPage, DocSearch, DocSearchPage, type DocSearchState, DocSidebar, DocViewPage, type DocsAdminActions, DocsAdminPage, DocsIndexPage, DocsLayout, type DocsState, EditButton, PageNavigation, TableOfContents, type TableOfContentsState, VersionSelector, useDocSearch, useDocs, useDocsAdmin, useTableOfContents };
+export { Breadcrumbs, DocPage, DocSearch, DocSearchPage, type DocSearchState, DocSidebar, DocViewPage, type DocsAdminActions, DocsAdminPage, DocsIndexPage, DocsLayout, type DocsSectionWithPages, type DocsState, EditButton, PageNavigation, TableOfContents, type TableOfContentsState, VersionSelector, type WithClassName, useDocSearch, useDocs, useDocsAdmin, useTableOfContents };