@fumadocs/base-ui 16.6.16 → 16.7.0

package/dist/layouts/notebook/index.d.ts

@@ -1,38 +1,39 @@
-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 { ComponentProps, FC, HTMLAttributes, ReactNode } from "react";
+import { BaseLayoutProps, GetLayoutTabsOptions, LayoutTab, NavOptions } from "../shared/index.js";
+import { SidebarProps, SidebarProviderProps } from "./slots/sidebar.js";
+import { DocsSlots, useNotebookLayout } from "./client.js";
+import { HTMLAttributes } from "react";
 import * as react_jsx_runtime0 from "react/jsx-runtime";
 import * as PageTree from "fumadocs-core/page-tree";
 
 //#region src/layouts/notebook/index.d.ts
 interface DocsLayoutProps extends BaseLayoutProps {
   tree: PageTree.Root;
+  tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
   tabMode?: 'sidebar' | 'navbar';
-  nav?: BaseLayoutProps['nav'] & {
-    mode?: 'top' | 'auto';
-  };
   sidebar?: SidebarOptions;
+  nav?: Nav;
   containerProps?: HTMLAttributes<HTMLDivElement>;
+  slots?: DocsSlots;
 }
-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'>>;
+interface Nav extends NavOptions {
+  mode?: 'top' | 'auto';
+}
+interface SidebarOptions extends SidebarProps, SidebarProviderProps {
   /**
-   * Support collapsing the sidebar on desktop mode
-   *
-   * @defaultValue true
+   * @deprecated use layout-level `tabs` option instead.
    */
-  collapsible?: boolean;
+  tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
 }
-declare function DocsLayout(props: DocsLayoutProps): react_jsx_runtime0.JSX.Element;
+declare function DocsLayout({
+  tree,
+  tabMode,
+  sidebar: {
+    tabs: defaultTabs,
+    ...sidebarProps
+  },
+  children,
+  tabs,
+  ...props
+}: DocsLayoutProps): react_jsx_runtime0.JSX.Element;
 //#endregion
-export { DocsLayout, DocsLayoutProps };
-//# sourceMappingURL=index.d.ts.map
+export { DocsLayout, DocsLayoutProps, type DocsSlots, useNotebookLayout };

package/dist/layouts/notebook/index.js

@@ -1,217 +1,22 @@
-import { cn } from "../../utils/cn.js";
-import { buttonVariants } from "../../components/ui/button.js";
-import { TreeContextProvider } from "../../contexts/tree.js";
-import { SidebarTabsDropdown } from "../../components/sidebar/tabs/dropdown.js";
-import { LinkItem } from "../../utils/link-item.js";
-import { LayoutBody, LayoutContextProvider, LayoutHeader, LayoutHeaderTabs, NavbarLinkItem } from "./client.js";
-import { LargeSearchToggle, SearchToggle } from "../shared/search-toggle.js";
-import { renderTitleNav, useLinkItems } from "../shared/index.js";
-import { LanguageToggle } from "../shared/language-toggle.js";
-import { ThemeToggle } from "../shared/theme-toggle.js";
-import { getSidebarTabs } from "../../components/sidebar/tabs/index.js";
-import { Sidebar as Sidebar$1, SidebarCollapseTrigger, SidebarContent, SidebarDrawer, SidebarLinkItem, SidebarPageTree, SidebarTrigger, SidebarViewport } from "./sidebar.js";
+import { getLayoutTabs } from "../shared/index.js";
+import { LayoutBody, useNotebookLayout } from "./client.js";
 import { useMemo } from "react";
-import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
-import { Languages, Sidebar, X } from "lucide-react";
+import { jsx } from "react/jsx-runtime";
 //#region src/layouts/notebook/index.tsx
-function DocsLayout(props) {
-	const { tabMode = "sidebar", nav = {}, sidebar: { tabs: tabOptions, defaultOpenLevel, prefetch, ...sidebarProps } = {}, i18n = false, themeSwitch = {}, tree } = props;
-	const navMode = nav.mode ?? "auto";
-	const { menuItems, navItems } = useLinkItems(props);
-	const tabs = useMemo(() => {
-		if (Array.isArray(tabOptions)) return tabOptions;
-		if (typeof tabOptions === "object") return getSidebarTabs(tree, tabOptions);
-		if (tabOptions !== false) return getSidebarTabs(tree);
-		return [];
-	}, [tabOptions, tree]);
-	function sidebar() {
-		const { banner, footer, components, collapsible = true, ...rest } = sidebarProps;
-		const iconLinks = menuItems.filter((item) => item.type === "icon");
-		const Header = typeof banner === "function" ? banner : ({ className, ...props }) => /* @__PURE__ */ jsxs("div", {
-			className: cn("flex flex-col gap-3 p-4 pb-2 empty:hidden", className),
-			...props,
-			children: [props.children, banner]
-		});
-		const Footer = typeof footer === "function" ? footer : ({ className, ...props }) => /* @__PURE__ */ jsxs("div", {
-			className: cn("hidden flex-row text-fd-muted-foreground items-center border-t p-4 pt-2", iconLinks.length > 0 && "max-lg:flex", className),
-			...props,
-			children: [props.children, footer]
-		});
-		const viewport = /* @__PURE__ */ jsxs(SidebarViewport, { children: [menuItems.filter((item) => item.type !== "icon").map((item, i, arr) => /* @__PURE__ */ jsx(SidebarLinkItem, {
-			item,
-			className: cn("lg:hidden", i === arr.length - 1 && "mb-4")
-		}, i)), /* @__PURE__ */ jsx(SidebarPageTree, { ...components })] });
-		return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsxs(SidebarContent, {
-			...rest,
-			children: [
-				/* @__PURE__ */ jsxs(Header, { children: [navMode === "auto" && /* @__PURE__ */ jsxs("div", {
-					className: "flex justify-between",
-					children: [renderTitleNav(nav, { className: "inline-flex items-center gap-2.5 font-medium" }), collapsible && /* @__PURE__ */ jsx(SidebarCollapseTrigger, {
-						className: cn(buttonVariants({
-							color: "ghost",
-							size: "icon-sm",
-							className: "mt-px mb-auto text-fd-muted-foreground"
-						})),
-						children: /* @__PURE__ */ jsx(Sidebar, {})
-					})]
-				}), tabs.length > 0 && /* @__PURE__ */ jsx(SidebarTabsDropdown, {
-					options: tabs,
-					className: cn(tabMode === "navbar" && "lg:hidden")
-				})] }),
-				viewport,
-				/* @__PURE__ */ jsx(Footer, { children: iconLinks.map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
-					item,
-					className: cn(buttonVariants({
-						size: "icon-sm",
-						color: "ghost",
-						className: "lg:hidden"
-					})),
-					"aria-label": item.label,
-					children: item.icon
-				}, i)) })
-			]
-		}), /* @__PURE__ */ jsxs(SidebarDrawer, {
-			...rest,
-			children: [
-				/* @__PURE__ */ jsxs(Header, { children: [/* @__PURE__ */ jsx(SidebarTrigger, {
-					className: cn(buttonVariants({
-						size: "icon-sm",
-						color: "ghost",
-						className: "ms-auto text-fd-muted-foreground"
-					})),
-					children: /* @__PURE__ */ jsx(X, {})
-				}), tabs.length > 0 && /* @__PURE__ */ jsx(SidebarTabsDropdown, { options: tabs })] }),
-				viewport,
-				/* @__PURE__ */ jsxs(Footer, {
-					className: cn("hidden flex-row items-center justify-end", (i18n || themeSwitch.enabled !== false) && "flex", iconLinks.length > 0 && "max-lg:flex"),
-					children: [
-						iconLinks.map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
-							item,
-							className: cn(buttonVariants({
-								size: "icon-sm",
-								color: "ghost"
-							}), "text-fd-muted-foreground lg:hidden", i === iconLinks.length - 1 && "me-auto"),
-							"aria-label": item.label,
-							children: item.icon
-						}, i)),
-						i18n && /* @__PURE__ */ jsx(LanguageToggle, { children: /* @__PURE__ */ jsx(Languages, { className: "size-4.5 text-fd-muted-foreground" }) }),
-						themeSwitch.enabled !== false && (themeSwitch.component ?? /* @__PURE__ */ jsx(ThemeToggle, { mode: themeSwitch.mode ?? "light-dark-system" }))
-					]
-				})
-			]
-		})] });
-	}
-	return /* @__PURE__ */ jsx(TreeContextProvider, {
+function DocsLayout({ tree, tabMode = "sidebar", sidebar: { tabs: defaultTabs, ...sidebarProps } = {}, children, tabs = defaultTabs, ...props }) {
+	return /* @__PURE__ */ jsx(LayoutBody, {
 		tree,
-		children: /* @__PURE__ */ jsx(LayoutContextProvider, {
-			navMode: nav.mode ?? "auto",
-			tabMode,
-			navTransparentMode: nav.transparentMode,
-			children: /* @__PURE__ */ jsx(Sidebar$1, {
-				defaultOpenLevel,
-				prefetch,
-				children: /* @__PURE__ */ jsxs(LayoutBody, {
-					...props.containerProps,
-					children: [
-						sidebar(),
-						/* @__PURE__ */ jsx(DocsNavbar, {
-							...props,
-							links: navItems,
-							tabs
-						}),
-						props.children
-					]
-				})
-			})
-		})
-	});
-}
-function DocsNavbar({ links, tabs, tabMode = "sidebar", sidebar: { collapsible: sidebarCollapsible = true } = {}, searchToggle = {}, themeSwitch = {}, nav = {}, i18n }) {
-	const navMode = nav.mode ?? "auto";
-	const showLayoutTabs = tabMode === "navbar" && tabs.length > 0;
-	return /* @__PURE__ */ jsxs(LayoutHeader, {
-		id: "nd-subnav",
-		className: cn("sticky [grid-area:header] flex flex-col top-(--fd-docs-row-1) z-10 backdrop-blur-sm transition-colors data-[transparent=false]:bg-fd-background/80 layout:[--fd-header-height:--spacing(14)]", showLayoutTabs && "lg:layout:[--fd-header-height:--spacing(24)]"),
-		children: [/* @__PURE__ */ jsxs("div", {
-			"data-header-body": "",
-			className: "flex border-b px-4 gap-2 h-14 md:px-6",
-			children: [
-				/* @__PURE__ */ jsxs("div", {
-					className: cn("items-center", navMode === "top" && "flex flex-1", navMode === "auto" && "hidden has-data-[collapsed=true]:md:flex max-md:flex"),
-					children: [
-						sidebarCollapsible && navMode === "auto" && /* @__PURE__ */ jsx(SidebarCollapseTrigger, {
-							className: cn(buttonVariants({
-								color: "ghost",
-								size: "icon-sm"
-							}), "text-fd-muted-foreground data-[collapsed=false]:hidden max-md:hidden"),
-							children: /* @__PURE__ */ jsx(Sidebar, {})
-						}),
-						renderTitleNav(nav, { className: cn("inline-flex items-center gap-2.5 font-semibold", navMode === "auto" && "md:hidden") }),
-						nav.children
-					]
-				}),
-				searchToggle.enabled !== false && (searchToggle.components?.lg ? /* @__PURE__ */ jsx("div", {
-					className: cn("w-full my-auto max-md:hidden", navMode === "top" ? "rounded-xl max-w-sm" : "max-w-[240px]"),
-					children: searchToggle.components.lg
-				}) : /* @__PURE__ */ jsx(LargeSearchToggle, {
-					hideIfDisabled: true,
-					className: cn("w-full my-auto max-md:hidden", navMode === "top" ? "rounded-xl max-w-sm ps-2.5" : "max-w-[240px]")
-				})),
-				/* @__PURE__ */ jsxs("div", {
-					className: "flex flex-1 items-center justify-end md:gap-2",
-					children: [
-						/* @__PURE__ */ jsx("div", {
-							className: "flex items-center gap-6 empty:hidden max-lg:hidden",
-							children: links.filter((item) => item.type !== "icon").map((item, i) => /* @__PURE__ */ jsx(NavbarLinkItem, { item }, i))
-						}),
-						links.filter((item) => item.type === "icon").map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
-							item,
-							className: cn(buttonVariants({
-								size: "icon-sm",
-								color: "ghost"
-							}), "text-fd-muted-foreground max-lg:hidden"),
-							"aria-label": item.label,
-							children: item.icon
-						}, i)),
-						/* @__PURE__ */ jsxs("div", {
-							className: "flex items-center md:hidden",
-							children: [searchToggle.enabled !== false && (searchToggle.components?.sm ?? /* @__PURE__ */ jsx(SearchToggle, {
-								hideIfDisabled: true,
-								className: "p-2"
-							})), /* @__PURE__ */ jsx(SidebarTrigger, {
-								className: cn(buttonVariants({
-									color: "ghost",
-									size: "icon-sm",
-									className: "p-2 -me-1.5"
-								})),
-								children: /* @__PURE__ */ jsx(Sidebar, {})
-							})]
-						}),
-						/* @__PURE__ */ jsxs("div", {
-							className: "flex items-center gap-2 max-md:hidden",
-							children: [
-								i18n && /* @__PURE__ */ jsx(LanguageToggle, { children: /* @__PURE__ */ jsx(Languages, { className: "size-4.5 text-fd-muted-foreground" }) }),
-								themeSwitch.enabled !== false && (themeSwitch.component ?? /* @__PURE__ */ jsx(ThemeToggle, { mode: themeSwitch.mode ?? "light-dark-system" })),
-								sidebarCollapsible && navMode === "top" && /* @__PURE__ */ jsx(SidebarCollapseTrigger, {
-									className: cn(buttonVariants({
-										color: "secondary",
-										size: "icon-sm"
-									}), "text-fd-muted-foreground rounded-full -me-1.5"),
-									children: /* @__PURE__ */ jsx(Sidebar, {})
-								})
-							]
-						})
-					]
-				})
-			]
-		}), showLayoutTabs && /* @__PURE__ */ jsx(LayoutHeaderTabs, {
-			"data-header-tabs": "",
-			className: "overflow-x-auto border-b px-6 h-10 max-lg:hidden",
-			options: tabs
-		})]
+		tabs: useMemo(() => {
+			if (Array.isArray(tabs)) return tabs;
+			if (typeof tabs === "object") return getLayoutTabs(tree, tabs);
+			if (tabs !== false) return getLayoutTabs(tree);
+			return [];
+		}, [tabs, tree]),
+		tabMode,
+		sidebar: sidebarProps,
+		...props,
+		children
 	});
 }
 //#endregion
-export { DocsLayout };
-
-//# sourceMappingURL=index.js.map
+export { DocsLayout, useNotebookLayout };

package/dist/layouts/notebook/page/client.d.ts

@@ -1,48 +1,98 @@
-import { ComponentProps } from "react";
+import { TOCProviderProps } from "../../../components/toc/index.js";
+import { TOCProps } from "./slots/toc.js";
+import { TOCPopoverProps } from "./slots/toc-popover.js";
+import { FooterProps } from "./slots/footer.js";
+import { BreadcrumbProps } from "./slots/breadcrumb.js";
+import { ComponentProps, FC, ReactNode } from "react";
 import * as react_jsx_runtime0 from "react/jsx-runtime";
-import { BreadcrumbOptions } from "fumadocs-core/breadcrumb";
-import * as PageTree from "fumadocs-core/page-tree";
+import { TOCItemType } from "fumadocs-core/toc";
 
 //#region src/layouts/notebook/page/client.d.ts
-declare function PageTOCPopover({
-  className,
+interface DocsPageSlots {
+  toc?: FC<TOCProps>;
+  container?: FC<ComponentProps<'article'>>;
+  tocPopover?: FC<TOCPopoverProps>;
+  tocProvider?: FC<TOCProviderProps>;
+  footer?: FC<FooterProps>;
+  breadcrumb?: FC<BreadcrumbProps>;
+}
+interface DocsPageProps extends ComponentProps<'article'> {
+  toc?: TOCItemType[];
+  /**
+   * Extend the page to fill all available space
+   *
+   * @defaultValue false
+   */
+  full?: boolean;
+  slots?: DocsPageSlots;
+  footer?: FooterOptions;
+  breadcrumb?: BreadcrumbOptions;
+  tableOfContent?: TableOfContentOptions;
+  tableOfContentPopover?: TableOfContentPopoverOptions;
+}
+interface BreadcrumbOptions extends BreadcrumbProps {
+  enabled?: boolean;
+  /**
+   * @deprecated use `slots.breadcrumb` instead.
+   */
+  component?: ReactNode;
+}
+interface FooterOptions extends FooterProps {
+  enabled?: boolean;
+  /**
+   * @deprecated use `slots.footer` instead.
+   */
+  component?: ReactNode;
+}
+interface TableOfContentOptions extends Pick<TOCProviderProps, 'single'>, TOCProps {
+  enabled?: boolean;
+  /**
+   * @deprecated use `slots.toc` instead.
+   */
+  component?: ReactNode;
+}
+interface TableOfContentPopoverOptions extends TOCPopoverProps {
+  enabled?: boolean;
+  /**
+   * @deprecated use `slots.tocPopover` instead.
+   */
+  component?: ReactNode;
+}
+interface PageSlotsProps extends Pick<DocsPageProps, 'full' | 'breadcrumb' | 'footer'> {
+  tableOfContent: TOCProps & {
+    component?: ReactNode;
+  };
+  tableOfContentPopover: TOCPopoverProps & {
+    component?: ReactNode;
+  };
+}
+declare function useDocsPage(): {
+  props: PageSlotsProps;
+  slots: DocsPageSlots;
+};
+declare function DocsPage({
+  tableOfContent: {
+    enabled: tocEnabled,
+    single,
+    ...tocProps
+  },
+  tableOfContentPopover: {
+    enabled: tocPopoverEnabled,
+    ...tocPopoverProps
+  },
+  footer,
+  breadcrumb,
+  full,
+  toc,
+  slots: defaultSlots,
   children,
-  ...rest
-}: ComponentProps<'div'>): react_jsx_runtime0.JSX.Element;
-declare function PageTOCPopoverTrigger({
-  className,
-  ...props
-}: ComponentProps<'button'>): react_jsx_runtime0.JSX.Element;
-declare function PageTOCPopoverContent(props: ComponentProps<'div'>): react_jsx_runtime0.JSX.Element;
+  ...containerProps
+}: DocsPageProps): react_jsx_runtime0.JSX.Element;
 declare function PageLastUpdate({
   date: value,
   ...props
 }: Omit<ComponentProps<'p'>, 'children'> & {
   date: Date;
 }): react_jsx_runtime0.JSX.Element;
-type Item = Pick<PageTree.Item, 'name' | 'description' | 'url'>;
-interface FooterProps extends ComponentProps<'div'> {
-  /**
-   * Items including information for the next and previous page
-   */
-  items?: {
-    previous?: Item;
-    next?: Item;
-  };
-}
-declare function PageFooter({
-  items,
-  children,
-  className,
-  ...props
-}: FooterProps): react_jsx_runtime0.JSX.Element;
-type BreadcrumbProps = BreadcrumbOptions & ComponentProps<'div'>;
-declare function PageBreadcrumb({
-  includeRoot,
-  includeSeparator,
-  includePage,
-  ...props
-}: BreadcrumbProps): react_jsx_runtime0.JSX.Element | null;
 //#endregion
-export { BreadcrumbProps, FooterProps, PageBreadcrumb, PageFooter, PageLastUpdate, PageTOCPopover, PageTOCPopoverContent, PageTOCPopoverTrigger };
-//# sourceMappingURL=client.d.ts.map
+export { DocsPage, DocsPageProps, DocsPageSlots, PageLastUpdate, useDocsPage };