fumadocs-ui/dist/layouts/docs/index.d.ts

The Radix UI version of Fumadocs UI

import { SidebarProvider } from "../../components/sidebar/base.js";
import { SidebarPageTreeComponents } from "../../components/sidebar/page-tree.js";
import { GetSidebarTabsOptions } from "../../components/sidebar/tabs/index.js";
import { SidebarTabWithProps } from "../../components/sidebar/tabs/dropdown.js";
import "./sidebar.js";
import { BaseLayoutProps } from "../shared/index.js";
import * as react_jsx_runtime115 from "react/jsx-runtime";
import { ComponentProps, HTMLAttributes, ReactNode } from "react";
import * as PageTree from "fumadocs-core/page-tree";

//#region src/layouts/docs/index.d.ts
interface DocsLayoutProps extends BaseLayoutProps {
  tree: PageTree.Root;
  sidebar?: SidebarOptions;
  tabMode?: 'top' | 'auto';
  /**
   * Props for the `div` container
   */
  containerProps?: HTMLAttributes<HTMLDivElement>;
}
interface SidebarOptions extends ComponentProps<'aside'>, Pick<ComponentProps<typeof SidebarProvider>, 'defaultOpenLevel' | 'prefetch'> {
  enabled?: boolean;
  component?: ReactNode;
  components?: Partial<SidebarPageTreeComponents>;
  /**
   * Root Toggle options
   */
  tabs?: SidebarTabWithProps[] | GetSidebarTabsOptions | false;
  banner?: ReactNode;
  footer?: ReactNode;
  /**
   * Support collapsing the sidebar on desktop mode
   *
   * @defaultValue true
   */
  collapsible?: boolean;
}
declare function DocsLayout({
  nav: {
    transparentMode,
    ...nav
  },
  sidebar: {
    tabs: sidebarTabs,
    enabled: sidebarEnabled,
    defaultOpenLevel,
    prefetch,
    ...sidebarProps
  },
  searchToggle,
  themeSwitch,
  tabMode,
  i18n,
  children,
  tree,
  ...props
}: DocsLayoutProps): react_jsx_runtime115.JSX.Element;
//#endregion
export { DocsLayout, DocsLayoutProps };
//# sourceMappingURL=index.d.ts.map