@stealthscale/component-navigation 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,101 +1,963 @@
-import { ComponentProps } from "react";
+import { Look, Palette } from "@stealthscale/theme/authoring";
+import { ComponentProps, ReactElement, ReactNode } from "react";
+import * as collapsible from "@zag-js/collapsible";
+import * as navigationMenu from "@zag-js/navigation-menu";
+import * as pagination from "@zag-js/pagination";
+import { ButtonProps } from "@stealthscale/component-actions";
+import * as toc from "@zag-js/toc";
 //#region src/breadcrumb/current-link.d.ts
 /**
- * Draws the name of the page itself, at full strength against the muted crumbs above it.
+ * Renders a span with `aria-current="page"` in the default ink.
  */
 declare const CurrentLink: import("@stealthscale/theme").StyledComponent<"span", {}>;
 /**
- * Describes what the current crumb takes.
+ * Describes the props of Breadcrumb.CurrentLink: the props of a span element.
  */
 type CurrentLinkProps = ComponentProps<typeof CurrentLink>;
 //#endregion
+//#region src/breadcrumb/ellipsis.d.ts
+/**
+ * Renders a list item in the muted ink.
+ */
+declare const Ellipsis$1: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of Breadcrumb.Ellipsis: the props of a list item element.
+ */
+type EllipsisProps$1 = ComponentProps<typeof Ellipsis$1>;
+//#endregion
 //#region src/breadcrumb/item.d.ts
 /**
- * Draws one row of the trail, carrying either a link to somewhere above or the name of the page
- * itself.
+ * Renders a list item that holds a `Breadcrumb.Link` or the `Breadcrumb.CurrentLink`.
  */
-declare const Item: import("@stealthscale/theme").StyledComponent<"li", {}>;
+declare const Item$4: import("@stealthscale/theme").StyledComponent<"li", {}>;
 /**
- * Describes what a crumb takes.
+ * Describes the props of Breadcrumb.Item: the props of a list item element.
  */
-type ItemProps = ComponentProps<typeof Item>;
+type ItemProps$4 = ComponentProps<typeof Item$4>;
 //#endregion
 //#region src/breadcrumb/link.d.ts
 /**
- * Draws a link to somewhere above the page.
+ * Renders an anchor in the muted ink that darkens on hover.
  */
-declare const Link$1: import("@stealthscale/theme").StyledComponent<"a", {}>;
+declare const Link$4: import("@stealthscale/theme").StyledComponent<"a", {}>;
 /**
- * Describes what a crumb's link takes.
+ * Describes the props of Breadcrumb.Link: the props of an anchor element.
  */
-type LinkProps$1 = ComponentProps<typeof Link$1>;
+type LinkProps$4 = ComponentProps<typeof Link$4>;
 //#endregion
 //#region src/breadcrumb/list.d.ts
 /**
- * Draws the crumbs in order, at the gap its size states.
+ * Renders an ordered list with `role="list"` and the gap of the size axis.
  */
-declare const List: import("@stealthscale/theme").StyledComponent<"ol", {}>;
+declare const List$2: import("@stealthscale/theme").StyledComponent<"ol", {}>;
 /**
- * Describes what the list takes.
+ * Describes the props of Breadcrumb.List: the props of an ordered list element.
  */
-type ListProps = ComponentProps<typeof List>;
+type ListProps$2 = ComponentProps<typeof List$2>;
 //#endregion
 //#region src/breadcrumb/root.d.ts
 /**
- * Draws the landmark and sets the size and look every part below it reads.
+ * Renders a `nav` and provides the size and variant to every part inside it.
  */
-declare const Root: import("@stealthscale/theme").StyledComponent<"nav", {
-  readonly size?: "lg" | "md" | "sm" | "xl" | "xs";
-  readonly variant?: "plain" | "underline";
+declare const Root$4: import("@stealthscale/theme").StyledComponent<"nav", {
+  readonly size?: "lg" | "md" | "sm" | "xl" | "xs" | undefined;
+  readonly variant?: "plain" | "underline" | undefined;
 }>;
 /**
- * Describes what the landmark takes.
+ * Describes the props of Breadcrumb.Root: the recipe's variants and the props of a nav element.
  */
-type RootProps = ComponentProps<typeof Root>;
+type RootProps$4 = ComponentProps<typeof Root$4>;
 //#endregion
 //#region src/breadcrumb/separator.d.ts
 /**
- * Draws the mark between two crumbs, saying nothing to a screen reader.
+ * Renders a list item hidden from the accessibility tree.
  */
 declare const Separator: import("@stealthscale/theme").StyledComponent<"li", {}>;
 /**
- * Describes what a separator takes.
+ * Describes the props of Breadcrumb.Separator: the props of a list item element.
  */
 type SeparatorProps = ComponentProps<typeof Separator>;
 declare namespace index_d_exports {
-  export { CurrentLink, CurrentLinkProps, Item, ItemProps, Link$1 as Link, LinkProps$1 as LinkProps, List, ListProps, Root, RootProps, Separator, SeparatorProps };
+  export { CurrentLink, CurrentLinkProps, Ellipsis$1 as Ellipsis, EllipsisProps$1 as EllipsisProps, Item$4 as Item, ItemProps$4 as ItemProps, Link$4 as Link, LinkProps$4 as LinkProps, List$2 as List, ListProps$2 as ListProps, Root$4 as Root, RootProps$4 as RootProps, Separator, SeparatorProps };
 }
 //#endregion
 //#region src/link/context.d.ts
 /**
- * Binds the link's recipe to the element that draws it.
+ * Binds the link recipe to React.
  *
  * @remarks
- *   Apart from the recipe, because an application's compiler reads the recipe at build time and
- *   the binding needs the runtime.
+ *   The binding is a separate module from the recipe, because an application's compiler imports the
+ *   recipe at build time and the binding needs the React runtime.
  */
 /**
- * Binds the recipe once, for the link and for whatever sets its variants from above.
+ * Factory for the link element and the provider that sets its variants for descendants.
  */
 declare const PropsProvider: import("react").Provider<import("@stealthscale/theme").DataAttrs & Partial<{
-  readonly variant?: "plain" | "underline";
+  readonly inherit?: boolean | undefined;
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly variant?: "plain" | "underline" | undefined;
 }>>, withContext: <Tag extends import("react").ElementType>(Component: Tag, options?: import("@stealthscale/theme").JsxFactoryOptions<import("@stealthscale/theme").ComponentProps<Tag> & Partial<{
-  readonly variant?: "plain" | "underline";
-}>> | undefined) => import("@stealthscale/theme").StyledComponent<Tag, {
-  readonly variant?: "plain" | "underline";
+  readonly inherit?: boolean | undefined;
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly variant?: "plain" | "underline" | undefined;
+}>, string> | undefined) => import("@stealthscale/theme").StyledComponent<Tag, {
+  readonly inherit?: boolean | undefined;
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly variant?: "plain" | "underline" | undefined;
 }>;
 //#endregion
 //#region src/link/link.d.ts
 /**
- * Draws words a person follows to somewhere else.
+ * Renders an anchor with the link recipe's classes.
  */
 export declare const Link: import("@stealthscale/theme").StyledComponent<"a", {
-  readonly variant?: "plain" | "underline";
+  readonly inherit?: boolean | undefined;
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly variant?: "plain" | "underline" | undefined;
 }>;
 /**
- * Describes what a link takes: the variants its recipe offers, and everything a styled anchor
- * takes.
+ * Describes the props of Link: the recipe's variants and the props of an anchor element.
  */
 type LinkProps = ComponentProps<typeof Link>;
 //#endregion
-export { index_d_exports as Breadcrumb, type LinkProps, PropsProvider as LinkPropsProvider };
+//#region src/nav-list/action.d.ts
+/**
+ * Renders the action `button` with the list's variants and `type` defaulting to `button`.
+ */
+declare const Action: import("@stealthscale/theme").StyledComponent<"button", {}>;
+/**
+ * Describes the props of `Action`.
+ */
+type ActionProps = ComponentProps<typeof Action>;
+//#endregion
+//#region src/nav-list/badge.d.ts
+/**
+ * Renders the count `span` with the list's variants.
+ */
+declare const Badge: import("@stealthscale/theme").StyledComponent<"span", {}>;
+/**
+ * Describes the props of `Badge`.
+ */
+type BadgeProps = ComponentProps<typeof Badge>;
+//#endregion
+//#region src/nav-list/machine.d.ts
+/**
+ * Describes the machine settings a caller can pass to a branch, all optional.
+ */
+type BranchOptions = Partial<collapsible.Props>;
+//#endregion
+//#region src/nav-list/branch.d.ts
+/**
+ * Renders the branch `li` with the list's variants.
+ */
+declare const Held$1: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of `Branch`: the machine settings and the styled `li` props.
+ */
+interface BranchProps extends BranchOptions, Omit<ComponentProps<typeof Held$1>, "dir" | "id"> {}
+/**
+ * Renders the branch and provides the running machine to its trigger, indicator and content.
+ *
+ * @remarks
+ *   Inside a search's scope, the branch registers the words it renders, its nested rows' words
+ *   among them, and is hidden while the scope's query is not in them. While the scope has a query
+ *   the branch is open, so a nested row that matches is visible, and a press on its trigger
+ *   changes nothing. The branch keeps its own open state and passes the machine a boolean `open`
+ *   at all times, so a cleared query returns the branch to the state it had before the query.
+ */
+declare function Branch(props: BranchProps): ReactElement;
+//#endregion
+//#region src/nav-list/content.d.ts
+/**
+ * Renders the nested `ul` with the list's variants.
+ */
+declare const Shown$1: import("@stealthscale/theme").StyledComponent<"ul", {}>;
+/**
+ * Describes the props of `Content`, less the `hidden` and `id` attributes the machine sets.
+ */
+type ContentProps$1 = Omit<ComponentProps<typeof Shown$1>, "hidden" | "id">;
+/**
+ * Renders the nested list with the machine's content props merged under the caller's.
+ */
+declare function Content$1(props: ContentProps$1): ReactElement;
+//#endregion
+//#region src/nav-list/indicator.d.ts
+/**
+ * Renders the indicator `span`, hidden from assistive technology.
+ */
+declare const Turned: import("@stealthscale/theme").StyledComponent<"span", {}>;
+/**
+ * Describes the props of `Indicator`.
+ */
+type IndicatorProps$2 = ComponentProps<typeof Turned>;
+/**
+ * Renders the indicator with the machine's indicator props merged under the caller's.
+ */
+declare function Indicator$2(props: IndicatorProps$2): ReactElement;
+//#endregion
+//#region src/nav-list/item.d.ts
+/**
+ * Renders the row `li` with the list's variants.
+ */
+declare const Row: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of `Item`.
+ */
+type ItemProps$3 = ComponentProps<typeof Row>;
+/**
+ * Renders the row, hidden while a search's query leaves it out.
+ *
+ * @param props - The `li` element's props.
+ * @returns The `li` element.
+ */
+declare function Item$3(props: ItemProps$3): ReactElement;
+//#endregion
+//#region src/nav-list/link.d.ts
+/**
+ * Renders the link `a` with the list's variants.
+ */
+declare const Anchored: import("@stealthscale/theme").StyledComponent<"a", {}>;
+/**
+ * Describes the props of `Link`: its tooltip and the props of an anchor.
+ */
+interface LinkProps$3 extends ComponentProps<typeof Anchored> {
+  /**
+   * Words the link shows in a tooltip while its list is iconic, usually the link's own words.
+   */
+  readonly tooltip?: ReactNode | undefined;
+}
+/**
+ * Renders the link, as the trigger of its tooltip while the list is iconic.
+ *
+ * @param props - The tooltip and the props of an anchor.
+ * @returns The `a` element, inside the tooltip's root on an iconic list.
+ */
+declare function Link$3({ tooltip, ...rest }: LinkProps$3): ReactElement;
+//#endregion
+//#region src/nav-list/mark.d.ts
+/**
+ * Renders the mark `span` with the list's variants, hidden from assistive technology.
+ */
+declare const Mark: import("@stealthscale/theme").StyledComponent<"span", {}>;
+/**
+ * Describes the props of `Mark`.
+ */
+type MarkProps = ComponentProps<typeof Mark>;
+//#endregion
+//#region src/nav-list/state.d.ts
+/**
+ * Provides the defaults a list below a provider starts from, and the state a list gives its rows.
+ *
+ * @remarks
+ *   A sidebar collapsed to a rail sets `iconic` once through the provider, and every list in it
+ *   renders its rows as icons. A list's own prop overrides the provider. A row reads whether its
+ *   list is iconic to decide whether it shows its tooltip.
+ */
+/**
+ * Describes the defaults a provider sets for every list below it.
+ */
+interface Defaults {
+  /**
+   * Whether the lists render their rows as icons.
+   */
+  readonly iconic?: boolean | undefined;
+  /**
+   * Size of the lists' rows.
+   */
+  readonly size?: "lg" | "md" | "sm" | undefined;
+}
+//#endregion
+//#region src/nav-list/props-provider.d.ts
+/**
+ * Describes the props of the provider: the defaults and the tree they apply to.
+ */
+interface PropsProviderProps {
+  /**
+   * The tree whose lists read the defaults.
+   */
+  readonly children?: ReactNode | undefined;
+  /**
+   * The defaults: whether the lists are iconic and the size of their rows.
+   */
+  readonly value: Defaults;
+}
+/**
+ * Renders the tree with the defaults in context.
+ *
+ * @param props - The defaults and the tree.
+ * @returns The tree inside the context.
+ */
+declare function PropsProvider$1({ children, value }: PropsProviderProps): ReactElement;
+//#endregion
+//#region src/nav-list/root.d.ts
+/**
+ * Renders the list `ul` and provides the variants to every part below it.
+ */
+declare const Listed$1: import("@stealthscale/theme").StyledComponent<"ul", {
+  readonly effect?: "glow" | undefined;
+  readonly guide?: "dashed" | "dotted" | "none" | "solid" | undefined;
+  readonly highlight?: import("@stealthscale/theme/authoring").Highlight | undefined;
+  readonly iconic?: boolean | undefined;
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly radius?: "full" | "l1" | "l2" | "l3" | undefined;
+  readonly reveal?: "always" | "hover" | undefined;
+  readonly size?: "lg" | "md" | "sm" | undefined;
+  readonly variant?: "dock" | "list" | undefined;
+}>;
+/**
+ * Describes the props of `Root`.
+ */
+type RootProps$3 = ComponentProps<typeof Listed$1>;
+/**
+ * Renders the list and handles the arrow keys that move focus between rows.
+ *
+ * @param props - The recipe's variants and the `ul` element's props.
+ * @returns The list.
+ */
+declare function Root$3({ iconic, size, ...rest }: RootProps$3): ReactElement;
+//#endregion
+//#region src/nav-list/skeleton.d.ts
+/**
+ * Renders the placeholder row `li` with the list's variants.
+ */
+declare const Skeleton: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of `Skeleton`.
+ */
+type SkeletonProps = ComponentProps<typeof Skeleton>;
+//#endregion
+//#region src/nav-list/trigger.d.ts
+/**
+ * Renders the trigger `button` with the list's variants.
+ */
+declare const Opened: import("@stealthscale/theme").StyledComponent<"button", {}>;
+/**
+ * Describes the props of `Trigger`, less the attributes the machine sets.
+ */
+type TriggerProps$1 = Omit<ComponentProps<typeof Opened>, "aria-controls" | "aria-expanded" | "type">;
+/**
+ * Renders the trigger with the machine's trigger props merged under the caller's.
+ */
+declare function Trigger$1(props: TriggerProps$1): ReactElement;
+declare namespace index_d_exports$1 {
+  export { Action, ActionProps, Badge, BadgeProps, Branch, BranchProps, Content$1 as Content, ContentProps$1 as ContentProps, Indicator$2 as Indicator, IndicatorProps$2 as IndicatorProps, Item$3 as Item, ItemProps$3 as ItemProps, Link$3 as Link, LinkProps$3 as LinkProps, Mark, MarkProps, PropsProvider$1 as PropsProvider, PropsProviderProps, Root$3 as Root, RootProps$3 as RootProps, Skeleton, SkeletonProps, Trigger$1 as Trigger, TriggerProps$1 as TriggerProps };
+}
+//#endregion
+//#region src/navigation-menu/content.d.ts
+/**
+ * Renders the `div` with the navigation menu's content class.
+ */
+declare const Drawn: import("@stealthscale/theme").StyledComponent<"div", {}>;
+/**
+ * Describes the props of the content: the props of a `div`, without `ref`, which the presence
+ * takes.
+ */
+type ContentProps = Omit<ComponentProps<typeof Drawn>, "ref">;
+/**
+ * Renders the panel with the machine's content props and the presence props merged over the
+ * caller's, inside the viewport while the menu renders one.
+ *
+ * @param props - The links and the props of a `div`.
+ * @returns The `div` element, or the two elements of the machine's beside a portal to the viewport.
+ */
+declare function Content(props: ContentProps): ReactElement;
+//#endregion
+//#region src/navigation-menu/indicator.d.ts
+/**
+ * Renders the `li` with the navigation menu's indicator class.
+ */
+declare const Marked: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of the indicator: the props of an `li`, without `ref`, which the presence
+ * takes.
+ */
+type IndicatorProps$1 = Omit<ComponentProps<typeof Marked>, "ref">;
+/**
+ * Renders the indicator with the machine's indicator props and the presence props merged over the
+ * caller's.
+ *
+ * @param props - The props of an `li`.
+ * @returns The `li` element.
+ */
+declare function Indicator$1(props: IndicatorProps$1): ReactElement;
+//#endregion
+//#region src/navigation-menu/scopes.d.ts
+/**
+ * Provides the item a part renders in, the viewport's alignment, and whether a panel closes once
+ * the pointer leaves it, to the parts that read them.
+ *
+ * @remarks
+ *   A trigger, a panel and a link read the value of the item they belong to, and the viewport reads
+ *   the alignment its positioner states. `useItem` throws for a part rendered outside an item.
+ */
+/**
+ * Describes the item a part belongs to.
+ */
+interface ItemScope {
+  /**
+   * Whether the item takes no pointer or key input.
+   */
+  readonly disabled?: boolean | undefined;
+  /**
+   * Value of the item, which the machine reports while the item is open.
+   */
+  readonly value: string;
+}
+/**
+ * Describes where the viewport is placed against the open trigger.
+ */
+type Align = "center" | "end" | "start";
+//#endregion
+//#region src/navigation-menu/item.d.ts
+/**
+ * Renders the `li` with the navigation menu's item class.
+ */
+declare const Held: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of an item: its value, whether it is disabled, and the props of an `li`.
+ */
+interface ItemProps$2 extends ItemScope, Omit<ComponentProps<typeof Held>, keyof ItemScope> {}
+/**
+ * Renders the item with the machine's item props, and provides the item to its parts.
+ *
+ * @param props - The value, the disabled state, the trigger and panel or the link, and the props of
+ *   an `li`.
+ * @returns The `li` element.
+ */
+declare function Item$2({ disabled, value, ...props }: ItemProps$2): ReactElement;
+//#endregion
+//#region src/navigation-menu/link.d.ts
+/**
+ * Renders the `a` with the navigation menu's link class.
+ */
+declare const Linked: import("@stealthscale/theme").StyledComponent<"a", {}>;
+/**
+ * Describes the props of a link: whether it leads to the current page, whether a press closes the
+ * menu, what runs on a press, and the props of an `a`.
+ */
+interface LinkProps$2 extends Omit<ComponentProps<typeof Linked>, "onSelect"> {
+  /**
+   * Whether a press closes the menu. Defaults to true.
+   */
+  readonly closeOnClick?: boolean | undefined;
+  /**
+   * Whether the link leads to the page on screen.
+   */
+  readonly current?: boolean | undefined;
+  /**
+   * Runs on a press before the menu closes. Calling `preventDefault` on the event keeps it open.
+   */
+  readonly onSelect?: ((event: CustomEvent) => void) | undefined;
+}
+/**
+ * Renders the link with the machine's link props for its item.
+ *
+ * @param props - Whether it is current, whether a press closes the menu, the press handler, the
+ *   words and the props of an `a`.
+ * @returns The `a` element.
+ */
+declare function Link$2({ closeOnClick, current, onSelect, ...props }: LinkProps$2): ReactElement;
+//#endregion
+//#region src/navigation-menu/list.d.ts
+/**
+ * Renders the `ul` with the navigation menu's list class.
+ */
+declare const Listed: import("@stealthscale/theme").StyledComponent<"ul", {}>;
+/**
+ * Describes the props of the list: the props of a `ul`.
+ */
+type ListProps$1 = ComponentProps<typeof Listed>;
+/**
+ * Renders the list with the machine's list props merged under the caller's.
+ *
+ * @param props - The items and the props of a `ul`.
+ * @returns The `ul` element.
+ */
+declare function List$1(props: ListProps$1): ReactElement;
+//#endregion
+//#region src/navigation-menu/machine.d.ts
+/**
+ * Describes the machine options, every one optional.
+ *
+ * @remarks
+ *   `translations` is left out, because the root takes its name as `aria-label`.
+ */
+type NavigationMenuOptions = Omit<Partial<navigationMenu.Props>, "translations">;
+/**
+ * Describes what `onValueChange` receives: the value of the open item, or an empty string once
+ * every item is closed.
+ */
+type ValueChangeDetails = navigationMenu.ValueChangeDetails;
+//#endregion
+//#region src/navigation-menu/metrics.d.ts
+/**
+ * Selects one of the three sizes the menu offers.
+ */
+type Step = "lg" | "md" | "sm";
+//#endregion
+//#region src/navigation-menu/root.d.ts
+/**
+ * Renders the `nav` that provides the recipe's variants.
+ */
+declare const Framed$1: import("@stealthscale/theme").StyledComponent<"nav", {
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly size?: Step | undefined;
+}>;
+/**
+ * Describes the props of the root: the machine's options, the recipe's variants and the props of a
+ * `nav`.
+ *
+ * @remarks
+ *   The element's own props of the same names as the machine's options are left out, so no prop has
+ *   two types.
+ */
+interface RootProps$2 extends NavigationMenuOptions, Omit<ComponentProps<typeof Framed$1>, "defaultValue" | "dir" | "id" | keyof NavigationMenuOptions> {}
+/**
+ * Renders the root and provides the machine's api to the parts.
+ *
+ * @param props - The machine's options, the recipe's variants and the props of a `nav`.
+ * @returns The `nav` element inside the providers.
+ */
+declare function Root$2({ palette, size, ...props }: RootProps$2): ReactElement;
+//#endregion
+//#region src/navigation-menu/trigger.d.ts
+/**
+ * Renders the `button` with the navigation menu's trigger class.
+ */
+declare const Pressed: import("@stealthscale/theme").StyledComponent<"button", {}>;
+/**
+ * Describes the props of the trigger: its words, its glyph and the props of a `button`.
+ */
+type TriggerProps = ComponentProps<typeof Pressed>;
+/**
+ * Renders the trigger with the machine's props for its item.
+ *
+ * @param props - The words, the glyph and the props of a `button`.
+ * @returns The `button` element.
+ */
+declare function Trigger(props: TriggerProps): ReactElement;
+//#endregion
+//#region src/navigation-menu/viewport-positioner.d.ts
+/**
+ * Renders the `div` with the navigation menu's viewport positioner class.
+ */
+declare const Placed: import("@stealthscale/theme").StyledComponent<"div", {}>;
+/**
+ * Describes the props of the viewport positioner: the viewport's alignment and the props of a
+ * `div`.
+ */
+interface ViewportPositionerProps extends ComponentProps<typeof Placed> {
+  /**
+   * Where the viewport sits against the open trigger. Defaults to `center`.
+   */
+  readonly align?: Align | undefined;
+}
+/**
+ * Renders the positioner with the machine's props, and provides the alignment to the viewport.
+ *
+ * @param props - The alignment, the viewport and the props of a `div`.
+ * @returns The `div` element.
+ */
+declare function ViewportPositioner({ align, ...props }: ViewportPositionerProps): ReactElement;
+//#endregion
+//#region src/navigation-menu/viewport.d.ts
+/**
+ * Renders the `div` with the navigation menu's viewport class.
+ */
+declare const Shown: import("@stealthscale/theme").StyledComponent<"div", {}>;
+/**
+ * Describes the props of the viewport: the props of a `div`, without `ref`, which the presence
+ * takes.
+ */
+type ViewportProps = Omit<ComponentProps<typeof Shown>, "ref">;
+/**
+ * Renders the viewport with the machine's viewport props and the presence props merged over the
+ * caller's.
+ *
+ * @param props - The props of a `div`.
+ * @returns The `div` element.
+ */
+declare function Viewport(props: ViewportProps): ReactElement;
+declare namespace index_d_exports$2 {
+  export { Content, ContentProps, Indicator$1 as Indicator, IndicatorProps$1 as IndicatorProps, Item$2 as Item, ItemProps$2 as ItemProps, Link$2 as Link, LinkProps$2 as LinkProps, List$1 as List, ListProps$1 as ListProps, Root$2 as Root, RootProps$2 as RootProps, Trigger, TriggerProps, ValueChangeDetails, Viewport, ViewportPositioner, ViewportPositionerProps, ViewportProps };
+}
+//#endregion
+//#region src/pagination/ellipsis.d.ts
+/**
+ * Renders the `span` with the pagination's ellipsis class.
+ */
+declare const Gap: import("@stealthscale/theme").StyledComponent<"span", {}>;
+/**
+ * Describes the props of the ellipsis: its place among the pages and the props of a `span`.
+ */
+interface EllipsisProps extends ComponentProps<typeof Gap> {
+  /**
+   * Index of the mark in the machine's list of pages.
+   */
+  readonly index: number;
+}
+/**
+ * Renders the ellipsis with the machine's props merged over the caller's.
+ *
+ * @param props - The mark's index and the props of a `span`.
+ * @returns The `span` element.
+ */
+declare function Ellipsis({ children, index, ...rest }: EllipsisProps): ReactElement;
+//#endregion
+//#region src/pagination/first-trigger.d.ts
+/**
+ * Describes the props of the first trigger: its accessible name and the props of a `Button`.
+ */
+interface FirstTriggerProps extends ButtonProps {
+  /**
+   * Accessible name of the trigger, "First page" unless the caller passes another.
+   */
+  readonly label?: string | undefined;
+}
+/**
+ * Renders the first trigger with the machine's props merged over the caller's.
+ *
+ * @param props - The trigger's name and the props of a `Button`.
+ * @returns The `button` element, or an `a` for links.
+ */
+declare function FirstTrigger({ label, ...rest }: FirstTriggerProps): ReactElement;
+//#endregion
+//#region src/pagination/item.d.ts
+/**
+ * Describes the props of a page: its number, its accessible name and the props of a `Button`.
+ */
+interface ItemProps$1 extends Omit<ButtonProps, "value"> {
+  /**
+   * Accessible name of the page, "Page N" unless the caller passes another.
+   */
+  readonly label?: string | undefined;
+  /**
+   * Number of the page, from one.
+   */
+  readonly value: number;
+}
+/**
+ * Renders a page with the machine's item props merged over the caller's.
+ *
+ * @param props - The page's number and name and the props of a `Button`.
+ * @returns The `button` element, or an `a` for links.
+ */
+declare function Item$1({ children, label, value, ...rest }: ItemProps$1): ReactElement;
+//#endregion
+//#region src/pagination/wording.d.ts
+/**
+ * Words the current page as text: "Page 12 of 24", "12 / 24" or "111–120 of 240".
+ */
+/**
+ * Describes the items of the current page by index, from zero.
+ */
+interface PageRange {
+  /**
+   * Index of the item after the page's last.
+   */
+  readonly end: number;
+  /**
+   * Index of the page's first item.
+   */
+  readonly start: number;
+}
+/**
+ * Describes where the reader is among the pages, as the machine counts it.
+ */
+interface PageDetails {
+  /**
+   * Number of items across every page.
+   */
+  readonly count: number;
+  /**
+   * Number of the current page, from one.
+   */
+  readonly page: number;
+  /**
+   * Indexes of the current page's first item and of the item after its last, from zero.
+   */
+  readonly pageRange: PageRange;
+  /**
+   * Number of pages.
+   */
+  readonly totalPages: number;
+}
+/**
+ * Selects how the page text words the current page, or a function that words it.
+ */
+type PageFormat = "compact" | "long" | "short" | ((details: PageDetails) => string);
+//#endregion
+//#region src/pagination/items.d.ts
+/**
+ * Describes the props of the items: the words that name a page and the words of the summary.
+ */
+interface ItemsProps {
+  /**
+   * Returns the accessible name of a page, "Page N" unless the caller passes another function.
+   */
+  readonly label?: ((page: number) => string) | undefined;
+  /**
+   * Format of the summary that replaces the pages while they do not fit the row, `compact`
+   * ("Page 12 of 24") unless the caller passes another.
+   */
+  readonly summary?: PageFormat | undefined;
+}
+/**
+ * Renders the pages, the marks between them and the summary.
+ *
+ * @param props - The function that names a page and the summary's format.
+ * @returns The items in the machine's order, then the summary.
+ */
+declare function Items({ label, summary }: ItemsProps): ReactElement;
+//#endregion
+//#region src/pagination/last-trigger.d.ts
+/**
+ * Describes the props of the last trigger: its accessible name and the props of a `Button`.
+ */
+interface LastTriggerProps extends ButtonProps {
+  /**
+   * Accessible name of the trigger, "Last page" unless the caller passes another.
+   */
+  readonly label?: string | undefined;
+}
+/**
+ * Renders the last trigger with the machine's props merged over the caller's.
+ *
+ * @param props - The trigger's name and the props of a `Button`.
+ * @returns The `button` element, or an `a` for links.
+ */
+declare function LastTrigger({ label, ...rest }: LastTriggerProps): ReactElement;
+//#endregion
+//#region src/pagination/next-trigger.d.ts
+/**
+ * Describes the props of the next trigger: its accessible name and the props of a `Button`.
+ */
+interface NextTriggerProps extends ButtonProps {
+  /**
+   * Accessible name of the trigger, "Next page" unless the caller passes another.
+   */
+  readonly label?: string | undefined;
+}
+/**
+ * Renders the next trigger with the machine's props merged over the caller's.
+ *
+ * @param props - The trigger's name and the props of a `Button`.
+ * @returns The `button` element, or an `a` for links.
+ */
+declare function NextTrigger({ label, ...rest }: NextTriggerProps): ReactElement;
+//#endregion
+//#region src/pagination/page-text.d.ts
+/**
+ * Renders the `output` with the pagination's page text class.
+ */
+declare const Stated: import("@stealthscale/theme").StyledComponent<"output", {}>;
+/**
+ * Describes the props of the page text: its format and the props of an `output` without children.
+ */
+interface PageTextProps extends Omit<ComponentProps<typeof Stated>, "children"> {
+  /**
+   * How the text words the current page, `compact` unless the caller passes another.
+   */
+  readonly format?: PageFormat | undefined;
+}
+/**
+ * Renders the text for the current page.
+ *
+ * @param props - The format and the props of an `output`.
+ * @returns The `output` element.
+ */
+declare function PageText({ format, ...rest }: PageTextProps): ReactElement;
+//#endregion
+//#region src/pagination/prev-trigger.d.ts
+/**
+ * Describes the props of the previous trigger: its accessible name and the props of a `Button`.
+ */
+interface PrevTriggerProps extends ButtonProps {
+  /**
+   * Accessible name of the trigger, "Previous page" unless the caller passes another.
+   */
+  readonly label?: string | undefined;
+}
+/**
+ * Renders the previous trigger with the machine's props merged over the caller's.
+ *
+ * @param props - The trigger's name and the props of a `Button`.
+ * @returns The `button` element, or an `a` for links.
+ */
+declare function PrevTrigger({ label, ...rest }: PrevTriggerProps): ReactElement;
+//#endregion
+//#region src/pagination/machine.d.ts
+/**
+ * Describes the machine settings a caller can pass to the root, all optional.
+ *
+ * @remarks
+ *   `translations` is left out, because a component's words are props: the root takes its name as
+ *   `aria-label`, and each trigger and page takes its own `label`.
+ */
+type PaginationOptions = Omit<Partial<pagination.Props>, "translations">;
+//#endregion
+//#region src/pagination/root.d.ts
+/**
+ * Renders the `nav` that provides the recipe's variants.
+ */
+declare const Framed: import("@stealthscale/theme").StyledComponent<"nav", {
+  readonly size?: "lg" | "md" | "sm" | undefined;
+}>;
+/**
+ * Describes the props of the root: the machine's options, the buttons' look and palette, the
+ * recipe's variants and the props of a `nav` without `ref`.
+ *
+ * @remarks
+ *   The element's `dir`, `id` and `page` are left out, because the machine takes all three. `page`
+ *   is otherwise the CSS property of that name.
+ */
+interface RootProps$1 extends Omit<ComponentProps<typeof Framed>, "dir" | "id" | "page" | "ref">, PaginationOptions {
+  /**
+   * Palette of the buttons, the button's own `primary` unless the caller sets another.
+   */
+  readonly palette?: Palette | undefined;
+  /**
+   * Look of the buttons, `ghost` unless the caller sets another. The current page is marked in
+   * every look.
+   */
+  readonly variant?: Look | undefined;
+}
+/**
+ * Renders the root, passes the buttons' variants down, and provides the running machine to the
+ * parts.
+ *
+ * @param props - The machine's options, the buttons' look and palette, the recipe's variants and
+ *   the props of a `nav`.
+ * @returns The `nav` element inside the providers.
+ */
+declare function Root$1({ "aria-label": label, palette, size, variant, ...props }: RootProps$1): ReactElement;
+declare namespace index_d_exports$3 {
+  export { Ellipsis, EllipsisProps, FirstTrigger, FirstTriggerProps, Item$1 as Item, ItemProps$1 as ItemProps, Items, ItemsProps, LastTrigger, LastTriggerProps, NextTrigger, NextTriggerProps, PageDetails, PageFormat, PageText, PageTextProps, PrevTrigger, PrevTriggerProps, Root$1 as Root, RootProps$1 as RootProps };
+}
+//#endregion
+//#region src/toc/indicator.d.ts
+/**
+ * List item with the indicator slot classes.
+ */
+declare const Styled$4: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of Toc.Indicator: the props of a list item element.
+ */
+type IndicatorProps = ComponentProps<typeof Styled$4>;
+/**
+ * Renders a list item positioned over the active rows, hidden from the accessibility tree.
+ */
+declare function Indicator(props: IndicatorProps): ReactElement;
+//#endregion
+//#region src/toc/machine.d.ts
+/**
+ * Describes the machine settings a caller can pass to the root, all optional.
+ */
+type TocOptions = Partial<toc.Props>;
+/**
+ * Describes one listed heading: its element id and its depth.
+ */
+type TocItem = toc.TocItem;
+//#endregion
+//#region src/toc/item.d.ts
+/**
+ * List item with the item slot classes.
+ */
+declare const Styled$3: import("@stealthscale/theme").StyledComponent<"li", {}>;
+/**
+ * Describes the props of Toc.Item: the heading and the props of a list item element.
+ */
+interface ItemProps extends ComponentProps<typeof Styled$3> {
+  /**
+   * Heading of the row: its element ID as `value` and its level as `depth`.
+   */
+  readonly item: TocItem;
+}
+/**
+ * Renders a list item with the depth and active state of its heading.
+ */
+declare function Item({ item, ...rest }: ItemProps): ReactElement;
+//#endregion
+//#region src/toc/link.d.ts
+/**
+ * Anchor with the link slot classes.
+ */
+declare const Styled$2: import("@stealthscale/theme").StyledComponent<"a", {}>;
+/**
+ * Describes the props of Toc.Link: the heading and the props of an anchor element.
+ */
+interface LinkProps$1 extends ComponentProps<typeof Styled$2> {
+  /**
+   * Heading the link points to: its element ID as `value` and its level as `depth`.
+   */
+  readonly item: TocItem;
+}
+/**
+ * Renders an anchor that sets `aria-current` while its heading is visible.
+ */
+declare function Link$1({ item, ...rest }: LinkProps$1): ReactElement;
+//#endregion
+//#region src/toc/list.d.ts
+/**
+ * Unordered list with the list slot classes.
+ */
+declare const Styled$1: import("@stealthscale/theme").StyledComponent<"ul", {}>;
+/**
+ * Describes the props of Toc.List: the props of an unordered list element.
+ */
+type ListProps = ComponentProps<typeof Styled$1>;
+/**
+ * Renders an unordered list with the ID the machine measures the rows against.
+ */
+declare function List(props: ListProps): ReactElement;
+//#endregion
+//#region src/toc/root.d.ts
+/**
+ * Nav element that provides the recipe's variants to the parts.
+ */
+declare const Landmark: import("@stealthscale/theme").StyledComponent<"nav", {
+  readonly palette?: "accent" | "error" | "info" | "neutral" | "primary" | "secondary" | "success" | "warning" | undefined;
+  readonly placement?: "aside" | "inline" | undefined;
+  readonly size?: "lg" | "md" | "sm" | undefined;
+}>;
+/**
+ * Describes the props of Toc.Root: the machine options, the recipe's variants and the props of a
+ * nav element.
+ *
+ * @remarks
+ *   The element's `id` and `dir` are omitted, because the machine sets both. It derives the
+ *   landmark's `aria-labelledby` from the ID and writes the direction to every part. The CSS
+ *   `scrollBehavior` style prop is omitted, so the name reaches the machine option that scrolls
+ *   the page to a heading.
+ */
+interface RootProps extends Omit<ComponentProps<typeof Landmark>, "dir" | "id" | "scrollBehavior">, TocOptions {
+  /**
+   * Headings of the page in document order, each with its element ID as `value` and its level as
+   * `depth`.
+   */
+  readonly items: TocItem[];
+}
+/**
+ * Renders a `nav` that runs the machine and provides its api to the parts, around a scroll area
+ * in the aside placement.
+ */
+declare function Root(props: RootProps): ReactElement;
+//#endregion
+//#region src/toc/title.d.ts
+/**
+ * Div with the title slot classes.
+ */
+declare const Styled: import("@stealthscale/theme").StyledComponent<"div", {}>;
+/**
+ * Describes the props of Toc.Title: the props of a div element.
+ */
+type TitleProps = ComponentProps<typeof Styled>;
+/**
+ * Renders a div with the ID the root's `aria-labelledby` references.
+ */
+declare function Title(props: TitleProps): ReactElement;
+declare namespace index_d_exports$4 {
+  export { Indicator, IndicatorProps, Item, ItemProps, Link$1 as Link, LinkProps$1 as LinkProps, List, ListProps, Root, RootProps, Title, TitleProps, TocItem };
+}
+//#endregion
+export { index_d_exports as Breadcrumb, type LinkProps, PropsProvider as LinkPropsProvider, index_d_exports$1 as NavList, index_d_exports$2 as NavigationMenu, index_d_exports$3 as Pagination, index_d_exports$4 as Toc };