fumadocs-ui/dist/layouts/notebook/page/index.d.ts

The Radix UI version of Fumadocs UI

import { BreadcrumbProps, FooterProps, PageBreadcrumb, PageLastUpdate } from "./client.js";
import * as react_jsx_runtime0 from "react/jsx-runtime";
import { ComponentProps, ReactNode } from "react";
import { AnchorProviderProps, TOCItemType } from "fumadocs-core/toc";

//#region src/layouts/notebook/page/index.d.ts
interface BreadcrumbOptions extends BreadcrumbProps {
  enabled: boolean;
  component: ReactNode;
}
interface FooterOptions extends FooterProps {
  enabled: boolean;
  component: ReactNode;
}
interface DocsPageProps {
  toc?: TOCItemType[];
  tableOfContent?: Partial<TableOfContentOptions>;
  tableOfContentPopover?: Partial<TableOfContentPopoverOptions>;
  /**
   * Extend the page to fill all available space
   *
   * @defaultValue false
   */
  full?: boolean;
  /**
   * Replace or disable breadcrumb
   */
  breadcrumb?: Partial<BreadcrumbOptions>;
  /**
   * Footer navigation, you can disable it by passing `false`
   */
  footer?: Partial<FooterOptions>;
  children?: ReactNode;
}
type TableOfContentOptions = Pick<AnchorProviderProps, 'single'> & {
  /**
   * Custom content in TOC container, before the main TOC
   */
  header?: ReactNode;
  /**
   * Custom content in TOC container, after the main TOC
   */
  footer?: ReactNode;
  enabled: boolean;
  component: ReactNode;
  /**
   * @defaultValue 'normal'
   */
  style?: 'normal' | 'clerk';
};
type TableOfContentPopoverOptions = Omit<TableOfContentOptions, 'single'>;
declare function DocsPage({
  breadcrumb: {
    enabled: breadcrumbEnabled,
    component: breadcrumb,
    ...breadcrumbProps
  },
  footer,
  full,
  tableOfContentPopover: {
    enabled: tocPopoverEnabled,
    component: tocPopover,
    ...tocPopoverOptions
  },
  tableOfContent: {
    enabled: tocEnabled,
    component: tocReplace,
    ...tocOptions
  },
  toc,
  children
}: DocsPageProps): ReactNode;
declare function EditOnGitHub(props: ComponentProps<'a'>): react_jsx_runtime0.JSX.Element;
/**
 * Add typography styles
 */
declare function DocsBody({
  children,
  className,
  ...props
}: ComponentProps<'div'>): react_jsx_runtime0.JSX.Element;
declare function DocsDescription({
  children,
  className,
  ...props
}: ComponentProps<'p'>): react_jsx_runtime0.JSX.Element | null;
declare function DocsTitle({
  children,
  className,
  ...props
}: ComponentProps<'h1'>): react_jsx_runtime0.JSX.Element;
//#endregion
export { DocsBody, DocsDescription, DocsPage, DocsPageProps, DocsTitle, EditOnGitHub, PageBreadcrumb, PageLastUpdate };
//# sourceMappingURL=index.d.ts.map