boltdocs 3.3.5 → 3.4.0

package/dist/client/primitives.d.cts

@@ -1,12 +1,12 @@
 
-import { ft as BoltdocsRoutePathWithFallback } from "../index-CgWkOCCn.cjs";
-import { $ as SidebarItem, J as Sidebar, Q as SidebarHeader, X as SidebarGroup, Y as SidebarContent, Z as SidebarGroupRenderProps, at as SidebarLinkProps, ct as SidebarSlots, et as SidebarItemProps, it as SidebarLink, lt as SidebarSubGroup, nt as SidebarItems, ot as SidebarMobile, qt as NavbarLink$1, rt as SidebarItemsProps, st as SidebarRoot, tt as SidebarItemRenderProps, ut as ComponentBase } from "../index-Bg-JtZeK.cjs";
+import { ft as BoltdocsRoutePathWithFallback } from "../index-RK7W_Fxy.cjs";
+import { $ as SidebarItem, J as Sidebar, Q as SidebarHeader, X as SidebarGroup, Y as SidebarContent, Yt as NavbarLink$1, Z as SidebarGroupRenderProps, at as SidebarLinkProps, ct as SidebarSlots, et as SidebarItemProps, it as SidebarLink, lt as SidebarSubGroup, nt as SidebarItems, ot as SidebarMobile, rt as SidebarItemsProps, st as SidebarRoot, tt as SidebarItemRenderProps, ut as ComponentBase } from "../index-B_o5y34l.cjs";
 import { a as CalloutRoot, c as CalloutTitleProps, i as CalloutProps, l as CalloutVariant, n as CalloutBody, o as CalloutRootProps, r as CalloutIcon, s as CalloutTitle, t as Callout } from "../callout-plqx9Dw-.cjs";
 import * as _$react from "react";
-import { CSSProperties, Component, ComponentProps, ComponentType, ErrorInfo, FC, HTMLAttributes, ImgHTMLAttributes, ReactNode, Ref, RefObject } from "react";
+import React$1, { CSSProperties, Component, ComponentProps, ComponentType, ErrorInfo, FC, HTMLAttributes, ImgHTMLAttributes, ReactNode, Ref, RefObject } from "react";
 import * as _$react_jsx_runtime0 from "react/jsx-runtime";
 import * as RAC from "react-aria-components";
-import { PopoverProps as PopoverProps$1 } from "react-aria-components";
+import { AutocompleteProps, ButtonProps as ButtonProps$1, DialogProps, InputProps, ListBoxItemProps, ListBoxProps, MenuItemProps, MenuProps, MenuSectionProps as MenuSectionProps$1, MenuTriggerProps as MenuTriggerProps$1, ModalOverlayProps, PopoverProps as PopoverProps$1, SearchFieldProps, SeparatorProps, SubmenuTriggerProps as SubmenuTriggerProps$1 } from "react-aria-components";
 
 //#region src/client/components/primitives/docs-layout.d.ts
 interface SlotProps {
@@ -93,8 +93,16 @@ declare namespace Tabs {
 }
 declare function TabsList({
   children,
-  className
-}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+  className,
+  role
+}: ComponentBase & {
+  /**
+   * Pass `null` when the "tabs" are plain navigation links (e.g. section
+   * tabs rendered as anchors): an ARIA `tablist` requires `tab` children and
+   * breaks otherwise. Omit to get the standard widget role.
+   */
+  role?: string | null;
+}): _$react_jsx_runtime0.JSX.Element;
 declare function TabsItem({
   children,
   id,
@@ -183,8 +191,11 @@ declare function AnchorProvider({
 }: AnchorProviderProps): _$react_jsx_runtime0.JSX.Element;
 declare function OnThisPage({
   children,
-  className
-}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+  className,
+  label
+}: ComponentBase & {
+  /** Accessible name for the TOC nav landmark. */label?: string;
+}): _$react_jsx_runtime0.JSX.Element;
 declare namespace OnThisPage {
   var Root: typeof OnThisPage;
   var Header: typeof OnThisPageHeader;
@@ -462,18 +473,25 @@ declare namespace Tooltip {
 }
 //#endregion
 //#region src/client/components/primitives/link.d.ts
-interface LinkProps extends Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
+interface LinkProps extends Omit<React$1.AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
   href?: BoltdocsRoutePathWithFallback;
   /** Alias for href, supported for React Router-style collection components. */
   to?: BoltdocsRoutePathWithFallback;
-  /** Should prefetch the page on hover? Default 'hover' */
-  prefetch?: 'hover' | 'none';
+  /**
+   * When to warm the destination's route chunk and loader data.
+   *
+   * - `hover` — on pointer enter or keyboard focus. Default.
+   * - `viewport` — also as soon as the link is about to be scrolled into view,
+   *   so readers who scroll and click never wait. Implies hover.
+   * - `none` — never prefetch.
+   */
+  prefetch?: 'hover' | 'viewport' | 'none';
   /** Wrap local navigation in the experimental View Transition API. */
   transition?: boolean;
   /** Native transition types for this link. */
   transitionTypes?: string[];
   /** Ref to the rendered anchor element. */
-  ref?: React.Ref<HTMLAnchorElement>;
+  ref?: React$1.Ref<HTMLAnchorElement>;
   /** Arbitrary `data-*` state attributes (e.g. `data-active`, `data-depth`). */
   [key: `data-${string}`]: string | number | boolean | undefined;
 }
@@ -499,9 +517,9 @@ interface NavLinkProps extends Omit<LinkProps, 'className' | 'children'> {
   /**
    * Provides access to the active state for conditional children rendering.
    */
-  children?: React.ReactNode | ((props: {
+  children?: React$1.ReactNode | ((props: {
     isActive: boolean;
-  }) => React.ReactNode);
+  }) => React$1.ReactNode);
   /**
    * Provides access to the active state for conditional styling.
    */
@@ -525,6 +543,12 @@ interface ErrorBoundaryProps {
   FallbackComponent?: ComponentType<FallbackProps>;
   onError?: (error: Error, info: ErrorInfo) => void;
   onReset?: () => void;
+  /**
+   * When any of these values change, a caught error is automatically
+   * reset (e.g. pass the current route path so navigation clears stale
+   * render errors).
+   */
+  resetKeys?: unknown[];
 }
 interface ErrorBoundaryState {
   hasError: boolean;
@@ -535,6 +559,8 @@ declare class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryS
   static getDerivedStateFromError(error: Error): ErrorBoundaryState;
   componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
   resetErrorBoundary: () => void;
+  private prevResetKeys;
+  componentDidUpdate(prevProps: ErrorBoundaryProps): void;
   render(): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | _$react.ReactPortal | _$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | _$react_jsx_runtime0.JSX.Element | null | undefined;
 }
 interface ErrorBoundaryFallbackProps {
@@ -591,7 +617,7 @@ declare function Image({
 /**
  * MenuTrigger wraps a trigger (usually a Button) and a Menu.
  */
-interface MenuTriggerProps extends RAC.MenuTriggerProps {
+interface MenuTriggerProps extends MenuTriggerProps$1 {
   placement?: PopoverProps['placement'];
   className?: string;
 }
@@ -603,7 +629,7 @@ declare function MenuTrigger({
 /**
  * SubmenuTrigger for nested menus.
  */
-interface SubmenuTriggerProps extends RAC.SubmenuTriggerProps {
+interface SubmenuTriggerProps extends SubmenuTriggerProps$1 {
   className?: string;
 }
 declare function SubmenuTrigger({
@@ -613,7 +639,7 @@ declare function SubmenuTrigger({
 /**
  * The Menu container.
  */
-declare function Menu<T extends object>(props: RAC.MenuProps<T>): _$react_jsx_runtime0.JSX.Element;
+declare function Menu<T extends object>(props: MenuProps<T>): _$react_jsx_runtime0.JSX.Element;
 declare namespace Menu {
   var Root: typeof Menu;
   var Item: typeof MenuItem;
@@ -625,7 +651,7 @@ declare namespace Menu {
 /**
  * MenuItem with support for selection states and submenus.
  */
-declare function MenuItem(props: RAC.MenuItemProps & {
+declare function MenuItem(props: MenuItemProps & {
   /** Class name for the content row. */contentClassName?: string; /** Class name for the multi-select check slot. */
   checkClassName?: string; /** Class name for the submenu chevron. */
   chevronClassName?: string; /** Custom multi-select check indicator. Replaces the default check. */
@@ -635,7 +661,7 @@ declare function MenuItem(props: RAC.MenuItemProps & {
 /**
  * MenuSection for grouping items with an optional header.
  */
-interface MenuSectionProps<T> extends RAC.MenuSectionProps<T> {
+interface MenuSectionProps<T> extends MenuSectionProps$1<T> {
   title?: string;
   headerClassName?: string;
 }
@@ -647,7 +673,7 @@ declare function MenuSection<T extends object>({
 /**
  * MenuSeparator for visual division.
  */
-declare function MenuSeparator(props: RAC.SeparatorProps): _$react_jsx_runtime0.JSX.Element;
+declare function MenuSeparator(props: SeparatorProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/client/components/primitives/page-nav.d.ts
 interface PageNavProps extends ComponentBase {
@@ -685,7 +711,7 @@ declare function PageNavIcon({
 }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/client/components/primitives/search-dialog.d.ts
-interface SearchDialogItemProps extends Omit<RAC.ListBoxItemProps, 'children'> {
+interface SearchDialogItemProps extends Omit<ListBoxItemProps, 'children'> {
   className?: string;
   children: React.ReactNode;
   /** Class name for the focused/selected "Select" hint. */
@@ -706,12 +732,12 @@ interface SearchDialogItemIconProps {
   icon?: React.ReactNode;
 }
 /**
- * Pure, unstyled SearchDialog Overlay (maps to RAC.ModalOverlay)
+ * Pure, unstyled SearchDialog Overlay (maps to ModalOverlay)
  */
 declare function SearchDialog({
   className,
   ...props
-}: RAC.ModalOverlayProps): _$react_jsx_runtime0.JSX.Element;
+}: ModalOverlayProps): _$react_jsx_runtime0.JSX.Element;
 declare namespace SearchDialog {
   var Root: typeof SearchDialog;
   var Overlay: typeof SearchDialog;
@@ -730,65 +756,65 @@ declare namespace SearchDialog {
   };
 }
 /**
- * Pure, unstyled SearchDialog Content (maps to RAC.Modal)
+ * Pure, unstyled SearchDialog Content (maps to Modal)
  */
 declare function SearchDialogContent({
   className,
   ...props
-}: RAC.ModalOverlayProps): _$react_jsx_runtime0.JSX.Element;
+}: ModalOverlayProps): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled SearchDialog Dialog (maps to RAC.Dialog)
+ * Pure, unstyled SearchDialog Dialog (maps to Dialog)
  */
 declare function SearchDialogDialog({
   children,
   className,
   ...props
-}: RAC.DialogProps): _$react_jsx_runtime0.JSX.Element;
+}: DialogProps): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled SearchDialog Input Field (maps to RAC.SearchField)
+ * Pure, unstyled SearchDialog Input Field (maps to SearchField)
  */
 declare function SearchDialogField({
   className,
   ...props
-}: RAC.SearchFieldProps): _$react_jsx_runtime0.JSX.Element;
+}: SearchFieldProps): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled SearchInput (maps to RAC.Input)
+ * Pure, unstyled SearchInput (maps to Input)
  */
 declare function SearchDialogSearchInput({
   className,
   ...props
-}: RAC.InputProps): _$react_jsx_runtime0.JSX.Element;
+}: InputProps): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled Clear Button (maps to RAC.Button with slot="clear")
+ * Pure, unstyled Clear Button (maps to Button with slot="clear")
  */
 declare function SearchDialogClearButton({
   className,
   ...props
-}: RAC.ButtonProps): _$react_jsx_runtime0.JSX.Element;
+}: ButtonProps$1): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled Autocomplete container (maps to RAC.Autocomplete)
+ * Pure, unstyled Autocomplete container (maps to Autocomplete)
  */
 declare function SearchDialogAutocomplete<T extends object>({
   children,
   className,
   innerClassName,
   ...props
-}: RAC.AutocompleteProps<T> & {
+}: AutocompleteProps<T> & {
   className?: string;
   innerClassName?: string;
 }): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled List Box (maps to RAC.ListBox)
+ * Pure, unstyled List Box (maps to ListBox)
  */
 declare function SearchDialogList<T extends object>({
   children,
   className,
   ...props
-}: RAC.ListBoxProps<T> & {
+}: ListBoxProps<T> & {
   className?: string;
 }): _$react_jsx_runtime0.JSX.Element;
 /**
- * Pure, unstyled List Box Item (maps to RAC.ListBoxItem)
+ * Pure, unstyled List Box Item (maps to ListBoxItem)
  */
 declare function SearchDialogItemRoot({
   children,
@@ -867,15 +893,25 @@ interface NavbarLinkProps extends Omit<ComponentBase, 'children'> {
 }
 interface NavbarLogoProps extends Omit<ComponentBase, 'children'> {
   src: string;
+  /** Source used while the `dark` class is absent from `<html>`. */
+  srcLight?: string;
+  /** Source used while the `dark` class is present on `<html>`. */
+  srcDark?: string | null;
   alt: string;
   width?: number;
   height?: number;
   href?: BoltdocsRoutePathWithFallback;
   /** Class name for the logo `<img>` element. */
   logoClassName?: string;
+  /** Class name for the light-theme logo `<img>`, when two are rendered. */
+  logoLightClassName?: string;
+  /** Class name for the dark-theme logo `<img>`, when two are rendered. */
+  logoDarkClassName?: string;
 }
 interface NavbarSearchTriggerProps extends ComponentBase {
   onPress: () => void;
+  'aria-label'?: string;
+  'aria-keyshortcuts'?: string;
 }
 interface NavbarThemeProps {
   className?: string;
@@ -934,11 +970,15 @@ declare function NavbarCenter({
 }: ComponentBase): _$react_jsx_runtime0.JSX.Element;
 declare function NavbarLogo({
   src,
+  srcLight,
+  srcDark,
   alt,
   width,
   height,
   className,
   logoClassName,
+  logoLightClassName,
+  logoDarkClassName,
   href
 }: NavbarLogoProps): _$react_jsx_runtime0.JSX.Element;
 declare function NavbarTitle({
@@ -953,8 +993,16 @@ declare function NavbarTitle({
 }): _$react_jsx_runtime0.JSX.Element;
 declare function NavbarLinks({
   children,
-  className
-}: ComponentBase): _$react_jsx_runtime0.JSX.Element;
+  className,
+  label
+}: ComponentBase & {
+  /**
+   * Accessible name for the nav landmark. Required when the page renders
+   * multiple navs (e.g. a docs navbar plus a sidebar) so landmarks stay
+   * distinguishable.
+   */
+  label?: string;
+}): _$react_jsx_runtime0.JSX.Element;
 declare function NavbarLink({
   label,
   href,
@@ -999,12 +1047,14 @@ declare function NavbarDropdownItem({
 declare function NavbarSearchTriggerDesktop({
   className,
   onPress,
-  children
+  children,
+  ...props
 }: NavbarSearchTriggerProps): _$react_jsx_runtime0.JSX.Element;
 declare function NavbarSearchTriggerMobile({
   className,
   onPress,
-  children
+  children,
+  ...props
 }: NavbarSearchTriggerProps): _$react_jsx_runtime0.JSX.Element;
 declare function NavbarSearchTriggerKbd({
   className,