@vx-oss/docs-react 1.0.3

package/dist/layouts/docs/slots/sidebar.js

@@ -0,0 +1,268 @@
+"use client";
+import { cn } from "../../../utils/cn.js";
+import { buttonVariants } from "../../../components/ui/button.js";
+import { mergeRefs } from "../../../utils/merge-refs.js";
+import { SearchTrigger } from "../../shared/slots/search-trigger.js";
+import { LinkItem } from "../../shared/client.js";
+import "../../shared/index.js";
+import { SidebarCollapseTrigger as SidebarCollapseTrigger$1, SidebarContent as SidebarContent$1, SidebarDrawerContent, SidebarDrawerOverlay, SidebarFolder as SidebarFolder$1, SidebarFolderContent as SidebarFolderContent$1, SidebarFolderLink as SidebarFolderLink$1, SidebarFolderTrigger as SidebarFolderTrigger$1, SidebarItem as SidebarItem$1, SidebarProvider as SidebarProvider$1, SidebarSeparator as SidebarSeparator$1, SidebarTrigger as SidebarTrigger$1, SidebarViewport, base_exports, useFolder, useFolderDepth } from "../../../components/sidebar/base.js";
+import { createPageTreeRenderer } from "../../../components/sidebar/page-tree.js";
+import { createLinkItemRenderer } from "../../../components/sidebar/link-item.js";
+import { SidebarTabsDropdown } from "../../../components/sidebar/tabs/dropdown.js";
+import { useDocsLayout } from "../client.js";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { ChevronDown, Languages, SidebarIcon } from "lucide-react";
+import { cva } from "class-variance-authority";
+import { useRef } from "react";
+//#region src/layouts/docs/slots/sidebar.tsx
+const itemVariants = cva("relative flex flex-row items-center gap-2 rounded-lg p-2 text-start text-fd-muted-foreground wrap-anywhere [&_svg]:size-4 [&_svg]:shrink-0", { variants: {
+	variant: {
+		link: "transition-colors hover:bg-fd-accent/50 hover:text-fd-accent-foreground/80 hover:transition-none data-[active=true]:bg-fd-primary/10 data-[active=true]:text-fd-primary data-[active=true]:hover:transition-colors",
+		button: "transition-colors hover:bg-fd-accent/50 hover:text-fd-accent-foreground/80 hover:transition-none"
+	},
+	highlight: { true: "data-[active=true]:before:content-[''] data-[active=true]:before:bg-fd-primary data-[active=true]:before:absolute data-[active=true]:before:w-px data-[active=true]:before:inset-y-2.5 data-[active=true]:before:inset-s-2.5" }
+} });
+const { useSidebar } = base_exports;
+function SidebarProvider(props) {
+	return /* @__PURE__ */ jsx(SidebarProvider$1, { ...props });
+}
+function Sidebar({ footer, banner, collapsible = true, components, ...rest }) {
+	const { menuItems, slots, props: { tabs, nav, tabMode } } = useDocsLayout();
+	const iconLinks = menuItems.filter((item) => item.type === "icon");
+	const viewport = /* @__PURE__ */ jsxs(SidebarViewport, { children: [menuItems.filter((v) => v.type !== "icon").map((item, i, list) => /* @__PURE__ */ jsx(SidebarLinkItem, {
+		item,
+		className: cn(i === list.length - 1 && "mb-4")
+	}, i)), /* @__PURE__ */ jsx(SidebarPageTree, { ...components })] });
+	return /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsxs(SidebarContent, {
+		...rest,
+		children: [
+			/* @__PURE__ */ jsxs("div", {
+				className: "flex flex-col gap-3 p-4 pb-2",
+				children: [
+					/* @__PURE__ */ jsxs("div", {
+						className: "flex",
+						children: [
+							slots.navTitle && /* @__PURE__ */ jsx(slots.navTitle, { className: "inline-flex text-[0.9375rem] items-center gap-2.5 font-medium me-auto" }),
+							nav?.children,
+							collapsible && /* @__PURE__ */ jsx(SidebarCollapseTrigger, {
+								className: cn(buttonVariants({
+									color: "ghost",
+									size: "icon-sm",
+									className: "mb-auto text-fd-muted-foreground"
+								})),
+								children: /* @__PURE__ */ jsx(SidebarIcon, {})
+							})
+						]
+					}),
+					slots.searchTrigger && /* @__PURE__ */ jsx(slots.searchTrigger.full, { hideIfDisabled: true }),
+					tabs.length > 0 && /* @__PURE__ */ jsx(SidebarTabsDropdown, { options: tabMode === "auto" ? tabs : tabs.filter((tab) => typeof tab.$folder?.root === "string") }),
+					banner
+				]
+			}),
+			viewport,
+			(slots.languageSelect || iconLinks.length > 0 || slots.themeSwitch || footer) && /* @__PURE__ */ jsxs("div", {
+				className: "flex flex-col p-4 pt-2",
+				children: [
+					slots.languageSelect && /* @__PURE__ */ jsxs(slots.languageSelect.root, {
+						variant: "secondary",
+						className: "text-fd-muted-foreground text-start justify-start bg-fd-secondary/50 mb-2",
+						children: [
+							/* @__PURE__ */ jsx(Languages, { className: "size-4.5" }),
+							/* @__PURE__ */ jsx(slots.languageSelect.text, {}),
+							/* @__PURE__ */ jsx(ChevronDown, { className: "ms-auto size-3.5" })
+						]
+					}),
+					/* @__PURE__ */ jsxs("div", {
+						className: "flex text-fd-muted-foreground items-center border bg-fd-secondary/50 p-0.5 pe-0 rounded-lg empty:hidden",
+						children: [iconLinks.map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
+							item,
+							className: cn(buttonVariants({
+								size: "icon-sm",
+								color: "ghost"
+							})),
+							"aria-label": item.label,
+							children: item.icon
+						}, i)), slots.themeSwitch && /* @__PURE__ */ jsx(slots.themeSwitch, { className: "px-1 py-0 border-y-0 border-e-0 rounded-none ms-auto *:rounded-md" })]
+					}),
+					footer
+				]
+			})
+		]
+	}), /* @__PURE__ */ jsxs(SidebarDrawer, { children: [
+		/* @__PURE__ */ jsxs("div", {
+			className: "flex flex-col gap-3 p-4 pb-2",
+			children: [
+				/* @__PURE__ */ jsxs("div", {
+					className: "flex text-fd-muted-foreground items-center gap-1.5",
+					children: [
+						/* @__PURE__ */ jsx("div", {
+							className: "flex flex-1",
+							children: iconLinks.map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
+								item,
+								className: cn(buttonVariants({
+									size: "icon-sm",
+									color: "ghost",
+									className: "p-2"
+								})),
+								"aria-label": item.label,
+								children: item.icon
+							}, i))
+						}),
+						slots.languageSelect && /* @__PURE__ */ jsxs(slots.languageSelect.root, { children: [/* @__PURE__ */ jsx(Languages, { className: "size-4.5" }), /* @__PURE__ */ jsx(slots.languageSelect.text, {})] }),
+						slots.themeSwitch && /* @__PURE__ */ jsx(slots.themeSwitch, { className: "p-0" }),
+						/* @__PURE__ */ jsx(SidebarTrigger, {
+							className: cn(buttonVariants({
+								color: "ghost",
+								size: "icon-sm",
+								className: "p-2"
+							})),
+							children: /* @__PURE__ */ jsx(SidebarIcon, {})
+						})
+					]
+				}),
+				tabs.length > 0 && /* @__PURE__ */ jsx(SidebarTabsDropdown, { options: tabs }),
+				banner
+			]
+		}),
+		viewport,
+		/* @__PURE__ */ jsx("div", {
+			className: "flex flex-col border-t p-4 pt-2 empty:hidden",
+			children: footer
+		})
+	] })] });
+}
+function SidebarFolder(props) {
+	return /* @__PURE__ */ jsx(SidebarFolder$1, { ...props });
+}
+function SidebarCollapseTrigger(props) {
+	return /* @__PURE__ */ jsx(SidebarCollapseTrigger$1, { ...props });
+}
+function SidebarTrigger(props) {
+	return /* @__PURE__ */ jsx(SidebarTrigger$1, { ...props });
+}
+function SidebarContent({ ref: refProp, className, children, ...props }) {
+	const ref = useRef(null);
+	return /* @__PURE__ */ jsx(SidebarContent$1, { children: ({ collapsed, hovered, ref: asideRef, ...rest }) => /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsxs("div", {
+		"data-sidebar-placeholder": "",
+		className: "sticky top-(--fd-docs-row-1) z-20 [grid-area:sidebar] pointer-events-none *:pointer-events-auto h-[calc(var(--fd-docs-height)-var(--fd-docs-row-1))] md:layout:[--fd-sidebar-width:268px] max-md:hidden",
+		children: [collapsed && /* @__PURE__ */ jsx("div", {
+			className: "absolute inset-s-0 inset-y-0 w-4",
+			...rest
+		}), /* @__PURE__ */ jsx("aside", {
+			id: "nd-sidebar",
+			ref: mergeRefs(ref, refProp, asideRef),
+			"data-collapsed": collapsed,
+			"data-hovered": collapsed && hovered,
+			className: cn("absolute flex flex-col w-full inset-s-0 inset-y-0 items-end bg-fd-card text-sm border-e duration-250 *:w-(--fd-sidebar-width)", collapsed && ["inset-y-2 rounded-xl transition-transform border w-(--fd-sidebar-width)", hovered ? "shadow-lg translate-x-2 rtl:-translate-x-2" : "-translate-x-(--fd-sidebar-width) rtl:translate-x-full"], ref.current && ref.current.getAttribute("data-collapsed") === "true" !== collapsed && "transition-[width,inset-block,translate,background-color]", className),
+			...props,
+			...rest,
+			children
+		})]
+	}), /* @__PURE__ */ jsxs("div", {
+		"data-sidebar-panel": "",
+		className: cn("fixed flex top-[calc(--spacing(4)+var(--fd-docs-row-3))] inset-s-4 shadow-lg transition-opacity rounded-xl p-0.5 border bg-fd-muted text-fd-muted-foreground z-10", (!collapsed || hovered) && "pointer-events-none opacity-0"),
+		children: [/* @__PURE__ */ jsx(SidebarCollapseTrigger$1, {
+			className: cn(buttonVariants({
+				color: "ghost",
+				size: "icon-sm",
+				className: "rounded-lg"
+			})),
+			children: /* @__PURE__ */ jsx(SidebarIcon, {})
+		}), /* @__PURE__ */ jsx(SearchTrigger, {
+			className: "rounded-lg",
+			hideIfDisabled: true
+		})]
+	})] }) });
+}
+function SidebarDrawer({ children, className, ...props }) {
+	return /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx(SidebarDrawerOverlay, { className: "fixed z-40 inset-0 backdrop-blur-xs data-[state=open]:animate-fd-fade-in data-[state=closed]:animate-fd-fade-out" }), /* @__PURE__ */ jsx(SidebarDrawerContent, {
+		className: cn("fixed text-[0.9375rem] flex flex-col shadow-lg border-s inset-e-0 inset-y-0 w-[85%] max-w-[380px] z-40 bg-fd-background data-[state=open]:animate-fd-sidebar-in data-[state=closed]:animate-fd-sidebar-out", className),
+		...props,
+		children
+	})] });
+}
+function SidebarSeparator({ className, style, children, ...props }) {
+	const depth = useFolderDepth();
+	return /* @__PURE__ */ jsx(SidebarSeparator$1, {
+		className: cn("inline-flex items-center gap-2 mb-1 px-2 mt-6 empty:mb-0 [&_svg]:size-4 [&_svg]:shrink-0", depth === 0 && "first:mt-0", className),
+		style: {
+			paddingInlineStart: getItemOffset(depth),
+			...style
+		},
+		...props,
+		children
+	});
+}
+function SidebarItem({ className, style, children, ...props }) {
+	const depth = useFolderDepth();
+	return /* @__PURE__ */ jsx(SidebarItem$1, {
+		className: cn(itemVariants({
+			variant: "link",
+			highlight: depth >= 1
+		}), className),
+		style: {
+			paddingInlineStart: getItemOffset(depth),
+			...style
+		},
+		...props,
+		children
+	});
+}
+function SidebarFolderTrigger({ className, style, ...props }) {
+	const { depth, collapsible } = useFolder();
+	return /* @__PURE__ */ jsx(SidebarFolderTrigger$1, {
+		className: cn(itemVariants({ variant: collapsible ? "button" : null }), "w-full", className),
+		style: {
+			paddingInlineStart: getItemOffset(depth - 1),
+			...style
+		},
+		...props,
+		children: props.children
+	});
+}
+function SidebarFolderLink({ className, style, ...props }) {
+	const depth = useFolderDepth();
+	return /* @__PURE__ */ jsx(SidebarFolderLink$1, {
+		className: cn(itemVariants({
+			variant: "link",
+			highlight: depth > 1
+		}), "w-full", className),
+		style: {
+			paddingInlineStart: getItemOffset(depth - 1),
+			...style
+		},
+		...props,
+		children: props.children
+	});
+}
+function SidebarFolderContent({ className, children, ...props }) {
+	const depth = useFolderDepth();
+	return /* @__PURE__ */ jsx(SidebarFolderContent$1, {
+		className: cn("relative", depth === 1 && "before:content-[''] before:absolute before:w-px before:inset-y-1 before:bg-fd-border before:inset-s-2.5", className),
+		...props,
+		children: /* @__PURE__ */ jsx("div", {
+			className: "flex flex-col gap-0.5 pt-0.5",
+			children
+		})
+	});
+}
+function getItemOffset(depth) {
+	return `calc(${2 + 3 * depth} * var(--spacing))`;
+}
+const SidebarPageTree = createPageTreeRenderer({
+	SidebarFolder,
+	SidebarFolderContent,
+	SidebarFolderLink,
+	SidebarFolderTrigger,
+	SidebarItem,
+	SidebarSeparator
+});
+const SidebarLinkItem = createLinkItemRenderer({
+	SidebarFolder,
+	SidebarFolderContent,
+	SidebarFolderLink,
+	SidebarFolderTrigger,
+	SidebarItem
+});
+//#endregion
+export { Sidebar, SidebarProvider, SidebarTrigger, useSidebar };

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

@@ -0,0 +1,61 @@
+import { BaseSlots, BaseSlotsProps } from "../shared/client.js";
+import { BaseLayoutProps, GetLayoutTabsOptions, LayoutTab, LinkItemType } from "../shared/index.js";
+import { TabDropdownProps } from "./slots/tab-dropdown.js";
+import { SidebarProps, SidebarProviderProps } from "./slots/sidebar.js";
+import { ComponentProps, FC, ReactNode } from "react";
+import * as PageTree from "@vx-oss/docs-core/page-tree";
+import { motion } from "motion/react";
+//#region src/layouts/flux/index.d.ts
+interface DocsSlots extends BaseSlots {
+  container: FC<ComponentProps<'div'>>;
+  tabDropdown: FC<TabDropdownProps>;
+  sidebar: {
+    provider: FC<SidebarProviderProps>;
+    trigger: FC<ComponentProps<'button'>>;
+    root: FC<SidebarProps>;
+    useSidebar: () => {
+      collapsed: boolean;
+      open: boolean;
+      setOpen: (v: boolean) => void;
+    };
+  };
+}
+interface DocsLayoutProps extends BaseLayoutProps {
+  tree: PageTree.Root;
+  sidebar?: SidebarOptions;
+  tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
+  slots?: Partial<DocsSlots>;
+  renderNavigationPanel?: (props: NavigationPanelProps) => ReactNode;
+  containerProps?: ComponentProps<'div'>;
+}
+interface SidebarOptions extends SidebarProps, SidebarProviderProps {
+  enabled?: boolean;
+  /**
+   * @deprecated use layout-level `tabs` instead.
+   */
+  tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
+}
+declare function useFluxLayout(): {
+  props: BaseSlotsProps;
+  menuItems: LinkItemType[];
+  navItems: LinkItemType[];
+  slots: DocsSlots;
+};
+declare function DocsLayout(props: DocsLayoutProps): import("react").JSX.Element;
+interface NavigationPanelProps {
+  head: ReactNode;
+  tabDropdown: ReactNode;
+  tool: ReactNode;
+  link: ReactNode;
+}
+declare function NavigationPanel({ head, tabDropdown, tool, link, children, ...props }: NavigationPanelProps & Omit<ComponentProps<typeof motion.div>, 'children'> & {
+  /**
+   * replace default children
+   */
+  children?: (defaultChildren: ReactNode) => ReactNode;
+}): import("react").JSX.Element;
+declare function NavigationPanelOverlay({ enabled, className, ...props }: ComponentProps<typeof motion.div> & {
+  enabled?: boolean;
+}): import("react").JSX.Element;
+//#endregion
+export { DocsLayout, DocsLayoutProps, DocsSlots, NavigationPanel, NavigationPanelOverlay, NavigationPanelProps, useFluxLayout };

package/dist/layouts/flux/index.js

@@ -0,0 +1,146 @@
+"use client";
+import { cn } from "../../utils/cn.js";
+import { buttonVariants } from "../../components/ui/button.js";
+import { TreeContextProvider } from "../../contexts/tree.js";
+import { useSearchContext } from "../../contexts/search.js";
+import { LinkItem, baseSlots } from "../shared/client.js";
+import { getLayoutTabs, useLinkItems } from "../shared/index.js";
+import { TabDropdown } from "./slots/tab-dropdown.js";
+import { Sidebar as Sidebar$1, SidebarProvider, SidebarTrigger, useSidebar } from "./slots/sidebar.js";
+import { Container } from "./slots/container.js";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { Languages } from "lucide-react";
+import { createContext, use, useMemo } from "react";
+import { motion } from "motion/react";
+import { RemoveScroll } from "react-remove-scroll";
+//#region src/layouts/flux/index.tsx
+const LayoutContext = createContext(null);
+function useFluxLayout() {
+	const context = use(LayoutContext);
+	if (!context) throw new Error("Please use Flux layout components under <DocsLayout /> (`@vx-oss/docs-react/layouts/flux`).");
+	return context;
+}
+const { useBaseSlots } = baseSlots({ useProps() {
+	return useFluxLayout().props;
+} });
+function DocsLayout(props) {
+	const { tree, nav = {}, sidebar: { enabled: sidebarEnabled = true, tabs: _tabs, defaultOpenLevel, prefetch, ...sidebarProps } = {}, tabs: defaultTabs = _tabs, children, containerProps, renderNavigationPanel = (props) => /* @__PURE__ */ jsx(NavigationPanel, { ...props }), slots: defaultSlots = {} } = props;
+	const linkItems = useLinkItems(props);
+	const { baseSlots, baseProps } = useBaseSlots(props);
+	const tabs = useMemo(() => {
+		if (Array.isArray(defaultTabs)) return defaultTabs;
+		if (typeof defaultTabs === "object") return getLayoutTabs(tree, defaultTabs);
+		if (defaultTabs !== false) return getLayoutTabs(tree);
+		return [];
+	}, [tree, defaultTabs]);
+	const slots = {
+		...baseSlots,
+		container: defaultSlots.container ?? Container,
+		tabDropdown: defaultSlots.tabDropdown ?? TabDropdown,
+		sidebar: defaultSlots.sidebar ?? {
+			root: Sidebar$1,
+			provider: SidebarProvider,
+			trigger: SidebarTrigger,
+			useSidebar
+		}
+	};
+	return /* @__PURE__ */ jsx(LayoutContext, {
+		value: {
+			props: baseProps,
+			slots,
+			...linkItems
+		},
+		children: /* @__PURE__ */ jsxs(TreeContextProvider, {
+			tree,
+			children: [/* @__PURE__ */ jsx(slots.sidebar.provider, {
+				defaultOpenLevel,
+				prefetch,
+				children: /* @__PURE__ */ jsxs(slots.container, {
+					...containerProps,
+					children: [sidebarEnabled && /* @__PURE__ */ jsx(slots.sidebar.root, { ...sidebarProps }), children]
+				})
+			}), renderNavigationPanel({
+				head: /* @__PURE__ */ jsxs(Fragment, { children: [slots.navTitle && /* @__PURE__ */ jsx(slots.navTitle, { className: "inline-flex items-center gap-2.5 text-sm font-semibold" }), nav.children] }),
+				tabDropdown: slots.tabDropdown && tabs.length > 0 && /* @__PURE__ */ jsx(slots.tabDropdown, {
+					className: "flex-1",
+					tabs
+				}),
+				tool: /* @__PURE__ */ jsxs(Fragment, { children: [
+					slots.languageSelect && /* @__PURE__ */ jsx(slots.languageSelect.root, { children: /* @__PURE__ */ jsx(Languages, { className: "size-4.5" }) }),
+					slots.searchTrigger && /* @__PURE__ */ jsx(slots.searchTrigger.sm, {
+						hideIfDisabled: true,
+						className: "rounded-lg"
+					}),
+					slots.sidebar && /* @__PURE__ */ jsx(slots.sidebar.trigger, { className: cn(buttonVariants({
+						variant: "ghost",
+						size: "icon-sm",
+						className: "overflow-hidden"
+					})) }),
+					slots.themeSwitch && /* @__PURE__ */ jsx(slots.themeSwitch, { className: "p-1 h-full ms-1 rounded-xl bg-fd-muted *:rounded-lg" })
+				] }),
+				link: linkItems.menuItems.filter((item) => item.type === "icon").map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
+					item,
+					className: cn(buttonVariants({
+						size: "icon-sm",
+						color: "ghost"
+					})),
+					"aria-label": item.label,
+					children: item.icon
+				}, i))
+			})]
+		})
+	});
+}
+function NavigationPanel({ head, tabDropdown, tool, link, children = (v) => v, ...props }) {
+	const { open } = useSearchContext();
+	return /* @__PURE__ */ jsx(motion.div, {
+		...props,
+		className: cn("fixed left-1/2 w-[calc(100%-var(--removed-body-scroll-bar-size,0px))] translate-x-[calc(-50%-var(--removed-body-scroll-bar-size,0px)/2)] bottom-0 z-40 bg-fd-popover text-fd-popover-foreground border-t shadow-lg sm:bottom-6 sm:rounded-2xl sm:border sm:max-w-[380px]", props.className),
+		animate: props.animate ?? {
+			scale: open ? .9 : 1,
+			translateY: open ? 20 : 0,
+			opacity: open ? .8 : 1
+		},
+		children: children(/* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsxs("div", {
+			className: "flex flex-row items-center ps-2.5 p-1 gap-2 min-h-11",
+			children: [head, /* @__PURE__ */ jsx("div", {
+				id: "flux-layout-slot",
+				className: "flex-1"
+			})]
+		}), /* @__PURE__ */ jsxs("div", {
+			className: "flex flex-row gap-1.5 overflow-x-auto overflow-y-hidden p-2 sm:p-1",
+			children: [
+				/* @__PURE__ */ jsx("div", {
+					className: "flex flex-row items-center gap-2 min-w-0 flex-1",
+					children: tabDropdown
+				}),
+				/* @__PURE__ */ jsx("div", {
+					className: "flex flex-row items-center text-fd-muted-foreground border-x px-0.5 empty:hidden",
+					children: link
+				}),
+				/* @__PURE__ */ jsx("div", {
+					className: "flex flex-row items-center text-fd-muted-foreground empty:hidden",
+					children: tool
+				})
+			]
+		})] }))
+	});
+}
+function NavigationPanelOverlay({ enabled = false, className, ...props }) {
+	return /* @__PURE__ */ jsx(RemoveScroll, {
+		enabled,
+		children: /* @__PURE__ */ jsx(motion.div, {
+			className: cn("fixed inset-0 z-30 pr-(--removed-body-scroll-bar-size,0) backdrop-blur-md bg-fd-background/60", !enabled && "pointer-events-none", className),
+			initial: "hide",
+			variants: {
+				show: { opacity: 1 },
+				hide: { opacity: 0 }
+			},
+			animate: enabled ? "show" : "hide",
+			exit: "hide",
+			...props
+		})
+	});
+}
+//#endregion
+export { DocsLayout, NavigationPanel, NavigationPanelOverlay, useFluxLayout };

package/dist/layouts/flux/page/index.d.ts

@@ -0,0 +1,67 @@
+import { MarkdownCopyButton, ViewOptionsPopover } from "../../shared/page-actions.js";
+import { TOCProps, TOCProviderProps } from "./slots/toc.js";
+import { Footer, FooterProps } from "./slots/footer.js";
+import { Breadcrumb, BreadcrumbProps } from "./slots/breadcrumb.js";
+import { ComponentProps, FC, ReactNode } from "react";
+import { TOCItemType } from "@vx-oss/docs-core/toc";
+//#region src/layouts/flux/page/index.d.ts
+interface DocsPageProps extends ComponentProps<'article'> {
+  toc?: TOCItemType[];
+  /**
+   * Extend the page to fill all available space
+   *
+   * @defaultValue false
+   */
+  full?: boolean | undefined;
+  slots?: Partial<DocsPageSlots>;
+  footer?: FooterOptions;
+  breadcrumb?: BreadcrumbOptions;
+  tableOfContent?: TableOfContentOptions;
+}
+type TableOfContentOptions = Pick<TOCProviderProps, 'single'> & TOCProps & {
+  enabled?: boolean;
+  /**
+   * @deprecated use `slots.toc` instead.
+   */
+  component?: ReactNode;
+};
+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 DocsPageSlots {
+  toc: {
+    provider: FC<TOCProviderProps>;
+    main: FC<TOCProps>;
+  };
+  container: FC<ComponentProps<'article'>>;
+  footer: FC<FooterProps>;
+  breadcrumb: FC<BreadcrumbProps>;
+}
+declare function useDocsPage(): {
+  full: NonNullable<DocsPageProps["full"]>;
+  slots: DocsPageSlots;
+};
+declare function DocsPage({ full, tableOfContent: { enabled: tocEnabled, single, ...tocProps }, breadcrumb: { enabled: breadcrumbEnabled, ...breadcrumb }, footer: { enabled: footerEnabled, ...footer }, toc, slots: defaultSlots, children, ...containerProps }: DocsPageProps): import("react").JSX.Element;
+declare function EditOnGitHub(props: ComponentProps<'a'>): import("react").JSX.Element;
+/**
+ * Add typography styles
+ */
+declare function DocsBody({ children, className, ...props }: ComponentProps<'div'>): import("react").JSX.Element;
+declare function DocsDescription({ children, className, ...props }: ComponentProps<'p'>): import("react").JSX.Element | null;
+declare function DocsTitle({ children, className, ...props }: ComponentProps<'h1'>): import("react").JSX.Element;
+declare function PageLastUpdate({ date: value, ...props }: Omit<ComponentProps<'p'>, 'children'> & {
+  date: Date;
+}): import("react").JSX.Element;
+//#endregion
+export { type BreadcrumbProps, DocsBody, DocsDescription, DocsPage, DocsPageProps, DocsTitle, EditOnGitHub, type FooterProps, MarkdownCopyButton, Breadcrumb as PageBreadcrumb, Footer as PageFooter, PageLastUpdate, ViewOptionsPopover, useDocsPage };

package/dist/layouts/flux/page/index.js

@@ -0,0 +1,104 @@
+"use client";
+import { cn } from "../../../utils/cn.js";
+import { buttonVariants } from "../../../components/ui/button.js";
+import { MarkdownCopyButton, ViewOptionsPopover } from "../../shared/page-actions.js";
+import { TOC, TOCProvider } from "./slots/toc.js";
+import { Footer } from "./slots/footer.js";
+import { Breadcrumb } from "./slots/breadcrumb.js";
+import { Container } from "./slots/container.js";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { Edit } from "lucide-react";
+import { createContext, use, useEffect, useState } from "react";
+import { useTranslations } from "@fuma-translate/react";
+//#region src/layouts/flux/page/index.tsx
+const PageContext = createContext(null);
+function useDocsPage() {
+	const context = use(PageContext);
+	if (!context) throw new Error("Please use page components under <DocsPage /> (`@vx-oss/docs-react/layouts/flux/page`).");
+	return context;
+}
+function DocsPage({ full = false, tableOfContent: { enabled: tocEnabled = !full, single, ...tocProps } = {}, breadcrumb: { enabled: breadcrumbEnabled = true, ...breadcrumb } = {}, footer: { enabled: footerEnabled = true, ...footer } = {}, toc = [], slots: defaultSlots = {}, children, ...containerProps }) {
+	const slots = {
+		breadcrumb: defaultSlots.breadcrumb ?? Breadcrumb,
+		footer: defaultSlots.footer ?? Footer,
+		container: defaultSlots.container ?? Container,
+		toc: defaultSlots.toc ?? {
+			provider: TOCProvider,
+			main: TOC
+		}
+	};
+	return /* @__PURE__ */ jsx(PageContext, {
+		value: {
+			full,
+			slots
+		},
+		children: /* @__PURE__ */ jsxs(slots.toc.provider, {
+			single,
+			toc: tocEnabled ? toc : [],
+			children: [tocEnabled && (tocProps.component ?? /* @__PURE__ */ jsx(slots.toc.main, { ...tocProps })), /* @__PURE__ */ jsxs(slots.container, {
+				...containerProps,
+				children: [
+					breadcrumbEnabled && (breadcrumb.component ?? /* @__PURE__ */ jsx(slots.breadcrumb, { ...breadcrumb })),
+					children,
+					footerEnabled && (footer.component ?? /* @__PURE__ */ jsx(slots.footer, { ...footer }))
+				]
+			})]
+		})
+	});
+}
+function EditOnGitHub(props) {
+	const t = useTranslations({ note: "edit page" });
+	return /* @__PURE__ */ jsx("a", {
+		target: "_blank",
+		rel: "noreferrer noopener",
+		...props,
+		className: cn(buttonVariants({
+			color: "secondary",
+			size: "sm"
+		}), "gap-1.5 not-prose", props.className),
+		children: props.children ?? /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx(Edit, { className: "size-3.5" }), t("Edit on GitHub")] })
+	});
+}
+/**
+* Add typography styles
+*/
+function DocsBody({ children, className, ...props }) {
+	return /* @__PURE__ */ jsx("div", {
+		...props,
+		className: cn("prose flex-1", className),
+		children
+	});
+}
+function DocsDescription({ children, className, ...props }) {
+	if (children === void 0) return null;
+	return /* @__PURE__ */ jsx("p", {
+		...props,
+		className: cn("mb-8 text-lg text-fd-muted-foreground", className),
+		children
+	});
+}
+function DocsTitle({ children, className, ...props }) {
+	return /* @__PURE__ */ jsx("h1", {
+		...props,
+		className: cn("text-[1.75em] font-semibold", className),
+		children
+	});
+}
+function PageLastUpdate({ date: value, ...props }) {
+	const t = useTranslations({ note: "page footer" });
+	const [date, setDate] = useState("");
+	useEffect(() => {
+		setDate(value.toLocaleDateString());
+	}, [value]);
+	return /* @__PURE__ */ jsxs("p", {
+		...props,
+		className: cn("text-sm text-fd-muted-foreground", props.className),
+		children: [
+			t("Last updated on"),
+			" ",
+			date
+		]
+	});
+}
+//#endregion
+export { DocsBody, DocsDescription, DocsPage, DocsTitle, EditOnGitHub, MarkdownCopyButton, Breadcrumb as PageBreadcrumb, Footer as PageFooter, PageLastUpdate, ViewOptionsPopover, useDocsPage };

package/dist/layouts/flux/page/slots/breadcrumb.d.ts

@@ -0,0 +1,7 @@
+import { ComponentProps } from "react";
+import { BreadcrumbOptions } from "@vx-oss/docs-core/breadcrumb";
+//#region src/layouts/flux/page/slots/breadcrumb.d.ts
+type BreadcrumbProps = BreadcrumbOptions & ComponentProps<'div'>;
+declare function Breadcrumb({ includeRoot, includeSeparator, includePage, ...props }: BreadcrumbProps): import("react").JSX.Element | null;
+//#endregion
+export { Breadcrumb, BreadcrumbProps };