@hanzo/docs-base-ui 16.5.0 → 16.7.5

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

@@ -0,0 +1,297 @@
+"use client";
+import { cn } from "../../../utils/cn.js";
+import { buttonVariants } from "../../../components/ui/button.js";
+import { mergeRefs } from "../../../utils/merge-refs.js";
+import { Popover, PopoverContent, PopoverTrigger } from "../../../components/ui/popover.js";
+import { LinkItem } from "../../shared/client.js";
+import { isLayoutTabActive } from "../../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 { useNotebookLayout } from "../client.js";
+import { createElement, useMemo, useRef, useState } from "react";
+import { usePathname } from "@hanzo/docs-core/framework";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+import Link from "@hanzo/docs-core/link";
+import { Check, ChevronsUpDown, Languages, SidebarIcon, X } from "lucide-react";
+import { cva } from "class-variance-authority";
+//#region src/layouts/notebook/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:start-2.5" }
+} });
+function getItemOffset(depth) {
+	return `calc(${2 + 3 * depth} * var(--spacing))`;
+}
+const { useSidebar } = base_exports;
+function SidebarProvider(props) {
+	return /* @__PURE__ */ jsx(SidebarProvider$1, { ...props });
+}
+function SidebarTrigger(props) {
+	return /* @__PURE__ */ jsx(SidebarTrigger$1, { ...props });
+}
+function SidebarCollapseTrigger(props) {
+	return /* @__PURE__ */ jsx(SidebarCollapseTrigger$1, { ...props });
+}
+function SidebarContent({ ref: refProp, className, children, ...props }) {
+	const { props: { nav } } = useNotebookLayout();
+	const navMode = nav?.mode ?? "auto";
+	const ref = useRef(null);
+	return /* @__PURE__ */ jsx(SidebarContent$1, { children: ({ collapsed, hovered, ref: asideRef, ...rest }) => /* @__PURE__ */ jsxs("div", {
+		"data-sidebar-placeholder": "",
+		className: cn("sticky z-20 [grid-area:sidebar] pointer-events-none *:pointer-events-auto md:layout:[--fd-sidebar-width:268px] max-md:hidden", navMode === "auto" ? "top-(--fd-docs-row-1) h-[calc(var(--fd-docs-height)-var(--fd-docs-row-1))]" : "top-(--fd-docs-row-2) h-[calc(var(--fd-docs-height)-var(--fd-docs-row-2))]"),
+		children: [collapsed && /* @__PURE__ */ jsx("div", {
+			className: "absolute start-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 start-0 inset-y-0 items-end text-sm duration-250 *:w-(--fd-sidebar-width)", navMode === "auto" && "bg-fd-card border-e", collapsed && ["inset-y-2 rounded-xl bg-fd-card 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
+		})]
+	}) });
+}
+function SidebarDrawer({ children, className, ...props }) {
+	return /* @__PURE__ */ jsxs(Fragment$1, { 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 end-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 SidebarFolder(props) {
+	return /* @__PURE__ */ jsx(SidebarFolder$1, { ...props });
+}
+function SidebarSeparator({ className, style, children, ...props }) {
+	const depth = useFolderDepth();
+	return /* @__PURE__ */ jsx(SidebarSeparator$1, {
+		className: cn("inline-flex items-center gap-2 mb-1.5 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: (state) => cn(itemVariants({ variant: collapsible ? "button" : null }), "w-full", typeof className === "function" ? className(state) : 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: (state) => cn("relative flex flex-col gap-0.5 pt-0.5", depth === 1 && "before:content-[''] before:absolute before:w-px before:inset-y-1 before:bg-fd-border before:start-2.5", typeof className === "function" ? className(state) : className),
+		...props,
+		children
+	});
+}
+const SidebarPageTree = createPageTreeRenderer({
+	SidebarFolder,
+	SidebarFolderContent,
+	SidebarFolderLink,
+	SidebarFolderTrigger,
+	SidebarItem,
+	SidebarSeparator
+});
+const SidebarLinkItem = createLinkItemRenderer({
+	SidebarFolder,
+	SidebarFolderContent,
+	SidebarFolderLink,
+	SidebarFolderTrigger,
+	SidebarItem
+});
+function Sidebar({ banner, footer, components, collapsible = true, ...rest }) {
+	const { menuItems, slots, props: { nav, tabs, tabMode } } = useNotebookLayout();
+	const navMode = nav?.mode ?? "auto";
+	const iconLinks = menuItems.filter((item) => item.type === "icon");
+	function renderHeader(props) {
+		if (typeof banner === "function") return createElement(banner, props);
+		return /* @__PURE__ */ jsxs("div", {
+			...props,
+			className: cn("flex flex-col gap-3 p-4 pb-2 empty:hidden", props.className),
+			children: [props.children, banner]
+		});
+	}
+	function renderFooter(props) {
+		if (typeof footer === "function") return createElement(footer, props);
+		return /* @__PURE__ */ jsxs("div", {
+			...props,
+			className: cn("hidden flex-row text-fd-muted-foreground items-center border-t p-4 pt-2", iconLinks.length > 0 && "max-lg:flex", props.className),
+			children: [props.children, footer]
+		});
+	}
+	const viewport = /* @__PURE__ */ jsx(SidebarViewport, { children: /* @__PURE__ */ jsxs("div", {
+		className: "flex flex-col gap-0.5",
+		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: [
+			renderHeader({ children: /* @__PURE__ */ jsxs(Fragment$1, { children: [navMode === "auto" && /* @__PURE__ */ jsxs("div", {
+				className: "flex justify-between",
+				children: [
+					slots.navTitle && /* @__PURE__ */ jsx(slots.navTitle, { className: "inline-flex items-center gap-2.5 font-medium" }),
+					nav?.children,
+					collapsible && /* @__PURE__ */ jsx(SidebarCollapseTrigger, {
+						className: cn(buttonVariants({
+							color: "ghost",
+							size: "icon-sm",
+							className: "mt-px mb-auto text-fd-muted-foreground"
+						})),
+						children: /* @__PURE__ */ jsx(SidebarIcon, {})
+					})
+				]
+			}), tabs.length > 0 && /* @__PURE__ */ jsx(SidebarTabsDropdown, {
+				options: tabs,
+				className: cn(tabMode === "navbar" && "lg:hidden")
+			})] }) }),
+			viewport,
+			renderFooter({ 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: [
+			renderHeader({ children: /* @__PURE__ */ jsxs(Fragment$1, { 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,
+			renderFooter({
+				className: cn("hidden flex-row items-center justify-end", (slots.languageSelect || slots.themeSwitch) && "flex", iconLinks.length > 0 && "max-lg:flex"),
+				children: /* @__PURE__ */ jsxs(Fragment$1, { 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)),
+					slots.languageSelect && /* @__PURE__ */ jsx(slots.languageSelect.root, { children: /* @__PURE__ */ jsx(Languages, { className: "size-4.5 text-fd-muted-foreground" }) }),
+					slots.themeSwitch && /* @__PURE__ */ jsx(slots.themeSwitch, {})
+				] })
+			})
+		]
+	})] });
+}
+function SidebarTabsDropdown({ options, placeholder, ...props }) {
+	const [open, setOpen] = useState(false);
+	const { closeOnRedirect } = useSidebar();
+	const pathname = usePathname();
+	const selected = useMemo(() => {
+		return options.findLast((item) => isLayoutTabActive(item, pathname));
+	}, [options, pathname]);
+	const onClick = () => {
+		closeOnRedirect.current = false;
+		setOpen(false);
+	};
+	const item = selected ? /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("div", {
+		className: "size-9 shrink-0 empty:hidden md:size-5",
+		children: selected.icon
+	}), /* @__PURE__ */ jsxs("div", { children: [/* @__PURE__ */ jsx("p", {
+		className: "text-sm font-medium",
+		children: selected.title
+	}), /* @__PURE__ */ jsx("p", {
+		className: "text-sm text-fd-muted-foreground empty:hidden md:hidden",
+		children: selected.description
+	})] })] }) : placeholder;
+	return /* @__PURE__ */ jsxs(Popover, {
+		open,
+		onOpenChange: setOpen,
+		children: [item && /* @__PURE__ */ jsxs(PopoverTrigger, {
+			...props,
+			className: cn("flex items-center gap-2 rounded-lg p-2 border bg-fd-secondary/50 text-start text-fd-secondary-foreground transition-colors hover:bg-fd-accent data-[state=open]:bg-fd-accent data-[state=open]:text-fd-accent-foreground", props.className),
+			children: [item, /* @__PURE__ */ jsx(ChevronsUpDown, { className: "shrink-0 ms-auto size-4 text-fd-muted-foreground" })]
+		}), /* @__PURE__ */ jsx(PopoverContent, {
+			className: "flex flex-col gap-1 w-(--radix-popover-trigger-width) p-1 fd-scroll-container",
+			children: options.map((item) => {
+				const isActive = selected && item.url === selected.url;
+				if (!isActive && item.unlisted) return;
+				return /* @__PURE__ */ jsxs(Link, {
+					href: item.url,
+					onClick,
+					...item.props,
+					className: cn("flex items-center gap-2 rounded-lg p-1.5 hover:bg-fd-accent hover:text-fd-accent-foreground", item.props?.className),
+					children: [
+						/* @__PURE__ */ jsx("div", {
+							className: "shrink-0 size-9 md:mb-auto md:size-5 empty:hidden",
+							children: item.icon
+						}),
+						/* @__PURE__ */ jsxs("div", { children: [/* @__PURE__ */ jsx("p", {
+							className: "text-sm font-medium leading-none",
+							children: item.title
+						}), /* @__PURE__ */ jsx("p", {
+							className: "text-[0.8125rem] text-fd-muted-foreground mt-1 empty:hidden",
+							children: item.description
+						})] }),
+						/* @__PURE__ */ jsx(Check, { className: cn("shrink-0 ms-auto size-3.5 text-fd-primary", !isActive && "invisible") })
+					]
+				}, item.url);
+			})
+		})]
+	});
+}
+//#endregion
+export { Sidebar, SidebarCollapseTrigger, SidebarProvider, SidebarTabsDropdown, SidebarTrigger, useSidebar };

package/dist/layouts/shared/client.d.ts

@@ -0,0 +1,45 @@
+import { LanguageSelectProps, LanguageSelectTextProps } from "./slots/language-select.js";
+import { FullSearchTriggerProps, SearchTriggerProps } from "./slots/search-trigger.js";
+import { ThemeSwitchProps } from "./slots/theme-switch.js";
+import { BaseLayoutProps, LinkItemType } from "./index.js";
+import { ComponentProps, FC } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/layouts/shared/client.d.ts
+declare function LinkItem({
+  ref,
+  item,
+  ...props
+}: Omit<ComponentProps<'a'>, 'href'> & {
+  item: Extract<LinkItemType, {
+    url: string;
+  }>;
+}): react_jsx_runtime0.JSX.Element;
+interface BaseSlots {
+  navTitle: FC<ComponentProps<'a'>>;
+  themeSwitch: FC<ThemeSwitchProps> | false;
+  searchTrigger: {
+    sm: FC<SearchTriggerProps>;
+    full: FC<FullSearchTriggerProps>;
+  } | false;
+  languageSelect: {
+    root: FC<LanguageSelectProps>;
+    text: FC<LanguageSelectTextProps>;
+  } | false;
+}
+interface BaseSlotsProps<P extends BaseLayoutProps = BaseLayoutProps> extends Pick<P, 'nav'> {
+  themeSwitch: Omit<NonNullable<P['themeSwitch']>, 'enabled'>;
+  searchToggle: Omit<NonNullable<P['searchToggle']>, 'enabled'>;
+}
+declare function baseSlots({
+  useProps
+}: {
+  useProps: () => BaseSlotsProps;
+}): {
+  useProvider(options: BaseLayoutProps): {
+    baseSlots: BaseSlots;
+    baseProps: BaseSlotsProps;
+  };
+};
+//#endregion
+export { BaseSlots, BaseSlotsProps, LinkItem, baseSlots };

package/dist/layouts/shared/client.js

@@ -0,0 +1,84 @@
+"use client";
+import { useI18n } from "../../contexts/i18n.js";
+import { LanguageSelect, LanguageSelectText } from "./slots/language-select.js";
+import { FullSearchTrigger, SearchTrigger } from "./slots/search-trigger.js";
+import { ThemeSwitch } from "./slots/theme-switch.js";
+import { isLinkItemActive } from "./index.js";
+import { usePathname } from "@hanzo/docs-core/framework";
+import { jsx } from "react/jsx-runtime";
+import Link from "@hanzo/docs-core/link";
+//#region src/layouts/shared/client.tsx
+function LinkItem({ ref, item, ...props }) {
+	const active = isLinkItemActive(item, usePathname());
+	return /* @__PURE__ */ jsx(Link, {
+		ref,
+		href: item.url,
+		external: item.external,
+		...props,
+		"data-active": active,
+		children: props.children
+	});
+}
+function baseSlots({ useProps }) {
+	function InlineThemeSwitch(props) {
+		const { themeSwitch } = useProps();
+		if (themeSwitch.component) return themeSwitch.component;
+		return /* @__PURE__ */ jsx(ThemeSwitch, {
+			...props,
+			...themeSwitch
+		});
+	}
+	function InlineSearchTrigger(props) {
+		const { searchToggle } = useProps();
+		if (searchToggle.components?.sm) return searchToggle.components.sm;
+		return /* @__PURE__ */ jsx(SearchTrigger, {
+			...props,
+			...searchToggle.sm
+		});
+	}
+	function InlineSearchTriggerFull(props) {
+		const { searchToggle } = useProps();
+		if (searchToggle.components?.lg) return searchToggle.components.lg;
+		return /* @__PURE__ */ jsx(FullSearchTrigger, {
+			...props,
+			...searchToggle.full
+		});
+	}
+	function InlineNavTitle({ href: defaultUrl = "/", ...props }) {
+		const { url = defaultUrl, title } = useProps().nav ?? {};
+		if (typeof title === "function") return title({
+			href: url,
+			...props
+		});
+		return /* @__PURE__ */ jsx(Link, {
+			href: url,
+			...props,
+			children: title
+		});
+	}
+	return { useProvider(options) {
+		const { locales = [] } = useI18n();
+		const { nav, slots = {}, i18n = locales.length > 1, searchToggle: { enabled: searchToggleEnabled = true, ...searchToggle } = {}, themeSwitch: { enabled: themeSwitchEnabled = true, ...themeSwitch } = {} } = options;
+		return {
+			baseSlots: {
+				navTitle: slots.navTitle ?? InlineNavTitle,
+				themeSwitch: themeSwitchEnabled && (slots.themeSwitch ?? InlineThemeSwitch),
+				languageSelect: i18n ? slots.languageSelect ?? {
+					root: LanguageSelect,
+					text: LanguageSelectText
+				} : false,
+				searchTrigger: searchToggleEnabled && (slots.searchTrigger ?? {
+					sm: InlineSearchTrigger,
+					full: InlineSearchTriggerFull
+				})
+			},
+			baseProps: {
+				nav,
+				searchToggle,
+				themeSwitch
+			}
+		};
+	} };
+}
+//#endregion
+export { LinkItem, baseSlots };

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

@@ -1,15 +1,15 @@
-import * as react_jsx_runtime27 from "react/jsx-runtime";
-import * as react10 from "react";
-import { ComponentProps, ReactNode } from "react";
-import { LinkItemType } from "@hanzo/docs-ui/link-item";
+import { FullSearchTriggerProps, SearchTriggerProps } from "./slots/search-trigger.js";
+import { ThemeSwitchProps } from "./slots/theme-switch.js";
+import { BaseSlots, BaseSlotsProps, LinkItem, baseSlots } from "./client.js";
+import { ComponentProps, FC, ReactNode } from "react";
+import * as PageTree from "@hanzo/docs-core/page-tree";
 import { I18nConfig } from "@hanzo/docs-core/i18n";
-export * from "@hanzo/docs-ui/link-item";
 
 //#region src/layouts/shared/index.d.ts
 interface NavOptions {
-  enabled: boolean;
-  component: ReactNode;
-  title?: ReactNode | ((props: ComponentProps<'a'>) => ReactNode);
+  enabled?: boolean;
+  children?: ReactNode;
+  title?: ReactNode | FC<ComponentProps<'a'>>;
   /**
    * Redirect url of title
    * @defaultValue '/'
@@ -21,38 +21,143 @@ interface NavOptions {
    * @defaultValue none
    */
   transparentMode?: 'always' | 'top' | 'none';
-  children?: ReactNode;
+  /**
+   * @deprecated use `slots.header` instead.
+   */
+  component?: ReactNode;
 }
 interface BaseLayoutProps {
-  themeSwitch?: {
-    enabled?: boolean;
-    component?: ReactNode;
-    mode?: 'light-dark' | 'light-dark-system';
-  };
-  searchToggle?: Partial<{
-    enabled: boolean;
-    components: Partial<{
-      sm: ReactNode;
-      lg: ReactNode;
-    }>;
-  }>;
-  /**
-   * I18n options
-   *
-   * @defaultValue false
-   */
-  i18n?: boolean | I18nConfig;
   /**
    * GitHub url
    */
   githubUrl?: string;
   links?: LinkItemType[];
   /**
-   * Replace or disable navbar
+   * navigation config
    */
-  nav?: Partial<NavOptions>;
+  nav?: NavOptions;
+  slots?: Partial<BaseSlots>;
   children?: ReactNode;
+  themeSwitch?: ThemeSwitchOptions;
+  searchToggle?: SearchToggleOptions;
+  /**
+   * @deprecated this is now optional for i18n setups, you can still customise language switch from `slots`.
+   */
+  i18n?: boolean | I18nConfig;
+}
+interface SearchToggleOptions {
+  enabled?: boolean;
+  sm?: SearchTriggerProps;
+  full?: FullSearchTriggerProps;
+  /** @deprecated use `slots.searchTrigger` instead */
+  components?: {
+    sm?: ReactNode;
+    lg?: ReactNode;
+  };
+}
+interface ThemeSwitchOptions extends ThemeSwitchProps {
+  enabled?: boolean;
+  /** @deprecated use `slots.themeSwitch` instead */
+  component?: ReactNode;
+}
+interface LayoutTab {
+  /**
+   * Redirect URL of the folder, usually the index page
+   */
+  url: string;
+  icon?: ReactNode;
+  title: ReactNode;
+  description?: ReactNode;
+  unlisted?: boolean;
+  props?: ComponentProps<'a'>;
+  /**
+   * bind to a page tree node.
+   */
+  $folder?: PageTree.Folder;
+  /**
+   * Detect from a list of urls (when not bound to page tree).
+   */
+  urls?: Set<string>;
+}
+interface GetLayoutTabsOptions {
+  transform?: (option: LayoutTab, node: PageTree.Folder) => LayoutTab | null;
+}
+declare function getLayoutTabs(tree: PageTree.Root, {
+  transform
+}?: GetLayoutTabsOptions): LayoutTab[];
+declare function isLayoutTabActive(tab: LayoutTab, pathname: string): boolean;
+interface Filterable {
+  /**
+   * Restrict where the item is displayed
+   *
+   * @defaultValue 'all'
+   */
+  on?: 'menu' | 'nav' | 'all';
+}
+interface WithHref {
+  url: string;
+  /**
+   * When the item is marked as active
+   *
+   * @defaultValue 'url'
+   */
+  active?: 'url' | 'nested-url' | 'none';
+  external?: boolean;
+}
+interface MainItemType extends WithHref, Filterable {
+  type?: 'main';
+  icon?: ReactNode;
+  text: ReactNode;
+  description?: ReactNode;
+}
+interface IconItemType extends WithHref, Filterable {
+  type: 'icon';
+  /**
+   * `aria-label` of icon button
+   */
+  label?: string;
+  icon: ReactNode;
+  text: ReactNode;
+  /**
+   * @defaultValue true
+   */
+  secondary?: boolean;
+}
+interface ButtonItemType extends WithHref, Filterable {
+  type: 'button';
+  icon?: ReactNode;
+  text: ReactNode;
+  /**
+   * @defaultValue false
+   */
+  secondary?: boolean;
+}
+interface MenuItemType extends Partial<WithHref>, Filterable {
+  type: 'menu';
+  icon?: ReactNode;
+  text: ReactNode;
+  items: ((MainItemType & {
+    /**
+     * Options when displayed on navigation menu
+     */
+    menu?: ComponentProps<'a'> & {
+      banner?: ReactNode;
+    };
+  }) | CustomItemType)[];
+  /**
+   * @defaultValue false
+   */
+  secondary?: boolean;
+}
+interface CustomItemType extends Filterable {
+  type: 'custom';
+  /**
+   * @defaultValue false
+   */
+  secondary?: boolean;
+  children: ReactNode;
 }
+type LinkItemType = MainItemType | IconItemType | ButtonItemType | MenuItemType | CustomItemType;
 /**
  * Get link items with shortcuts
  */
@@ -60,10 +165,14 @@ declare function resolveLinkItems({
   links,
   githubUrl
 }: Pick<BaseLayoutProps, 'links' | 'githubUrl'>): LinkItemType[];
-declare function renderTitleNav({
-  title,
-  url
-}: Partial<NavOptions>, props: ComponentProps<'a'>): string | number | bigint | boolean | react_jsx_runtime27.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react10.ReactPortal | react10.ReactElement<unknown, string | react10.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
+declare function useLinkItems({
+  githubUrl,
+  links
+}: Pick<BaseLayoutProps, 'links' | 'githubUrl'>): {
+  navItems: LinkItemType[];
+  menuItems: LinkItemType[];
+  all: LinkItemType[];
+};
+declare function isLinkItemActive(link: LinkItemType, pathname: string): boolean;
 //#endregion
-export { BaseLayoutProps, NavOptions, renderTitleNav, resolveLinkItems };
-//# sourceMappingURL=index.d.ts.map
+export { BaseLayoutProps, type BaseSlots, type BaseSlotsProps, ButtonItemType, CustomItemType, GetLayoutTabsOptions, IconItemType, LayoutTab, LinkItem, LinkItemType, MainItemType, MenuItemType, NavOptions, baseSlots, getLayoutTabs, isLayoutTabActive, isLinkItemActive, resolveLinkItems, useLinkItems };