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

The Radix UI version of Fumadocs UI

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 { BaseLayoutProps } from "../shared/index.js";
import { Sidebar } from "./sidebar.js";
import * as react_jsx_runtime135 from "react/jsx-runtime";
import { ComponentProps, FC, HTMLAttributes, ReactNode } from "react";
import * as PageTree from "fumadocs-core/page-tree";

//#region src/layouts/notebook/index.d.ts
interface DocsLayoutProps extends BaseLayoutProps {
  tree: PageTree.Root;
  tabMode?: 'sidebar' | 'navbar';
  nav?: BaseLayoutProps['nav'] & {
    mode?: 'top' | 'auto';
  };
  sidebar?: SidebarOptions;
  containerProps?: HTMLAttributes<HTMLDivElement>;
}
interface SidebarOptions extends ComponentProps<'aside'>, Pick<ComponentProps<typeof Sidebar>, 'defaultOpenLevel' | 'prefetch'> {
  components?: Partial<SidebarPageTreeComponents>;
  /**
   * Root Toggle options
   */
  tabs?: SidebarTabWithProps[] | GetSidebarTabsOptions | false;
  banner?: ReactNode | FC<ComponentProps<'div'>>;
  footer?: ReactNode | FC<ComponentProps<'div'>>;
  /**
   * Support collapsing the sidebar on desktop mode
   *
   * @defaultValue true
   */
  collapsible?: boolean;
}
declare function DocsLayout(props: DocsLayoutProps): react_jsx_runtime135.JSX.Element;
//#endregion
export { DocsLayout, DocsLayoutProps };
//# sourceMappingURL=index.d.ts.map