@marktiderman/genesis-ui 2.12.0 → 2.12.2

package/dist/navigation-By1DrzaM.d.ts

@@ -1,190 +0,0 @@
-import { ComponentType, ReactNode, AnchorHTMLAttributes } from 'react';
-
-/**
- * Router-agnostic navigation primitives.
- *
- * genesis-ui does NOT depend on any router. Components that need to render a
- * link or navigate imperatively accept an injectable abstraction defined here,
- * and default to plain browser behavior (`<a>` / `window.location`). Consumers
- * on a router inject an adapter that maps these props to their own `<Link>` /
- * router. Ready-made ones ship on their own subpaths, each with its router as
- * an optional peer: `@marktiderman/genesis-ui/router/react-router` and
- * `@marktiderman/genesis-ui/router/tanstack-router`. Next.js passes
- * `next/link` directly.
- */
-
-/**
- * Props passed to an injectable link component. The contract is a plain anchor
- * (`href`), so the default works with NO router. A React Router consumer maps
- * `href` → `to`; a Next.js consumer passes `next/link` directly (it already
- * accepts `href`, `className`, `children`).
- *
- * @stability Beta
- */
-interface GenesisLinkProps {
-    /** Destination path or URL. */
-    href: string;
-    className?: string;
-    onClick?: () => void;
-    children?: ReactNode;
-    /** Set to "page" when the link points at the active route. */
-    "aria-current"?: AnchorHTMLAttributes<HTMLAnchorElement>["aria-current"];
-    /** Accessible name — useful when the visible label is hidden (icon rail). */
-    "aria-label"?: string;
-    /** Native tooltip / title attribute. */
-    title?: string;
-    /**
-     * Stable test/automation selector. {@link DefaultLink} renders it as
-     * `data-testid`; injected router adapters (`next/link`, RR `Link`) forward it
-     * to the underlying `<a>` too.
-     */
-    testID?: string;
-}
-/**
- * A component that renders a navigable link from {@link GenesisLinkProps}.
- *
- * @stability Beta
- */
-type LinkComponent = ComponentType<GenesisLinkProps>;
-/**
- * Default link — a plain `<a>`. No router required.
- *
- * @stability Beta
- */
-declare const DefaultLink: LinkComponent;
-/**
- * Options for {@link isPathActive}.
- *
- * @stability Beta
- */
-interface IsPathActiveOptions {
-    /** Require an exact path match instead of a prefix match (like `NavLink end`). */
-    end?: boolean;
-}
-/**
- * Default active-path matcher, mirroring React Router's `NavLink` (prefix
- * match, with `/` treated as exact). Consumers can override via an `isActive`
- * prop where components accept one.
- *
- * `activePath` may carry a query and hash (`pathname + search + hash`). An
- * item whose `to` has neither compares against the path part only, exactly as
- * before. An item that opts in by putting a query or hash in its `to`
- * (`/admin?tab=users`, `/settings#profile`) is active only when the path
- * matches exactly AND every query param it names has the same value in
- * `activePath` (extra params such as `&page=2` are ignored) AND, if it names a
- * hash, the hash is equal.
- *
- * @stability Beta
- */
-declare function isPathActive(to: string, activePath?: string, options?: IsPathActiveOptions): boolean;
-/**
- * One node of a logical navigation hierarchy. `path` is a route pattern whose
- * segments are either static (`clients`) or named params (`$clientId`). A
- * node's place in the tree is its LOGICAL parent, which need not share its URL
- * prefix — `/clients/$clientId` can sit under `/dashboard`.
- *
- * @stability Beta
- */
-interface NavigationNode<T> {
-    id: string;
-    path: string;
-    label: string;
-    /** Contextual nav items to show while this node is current. */
-    items: T[];
-    children?: NavigationNode<T>[];
-    /**
-     * Ask the app shell to open its desktop sidebar collapsed (icon rail) while
-     * this node, or a descendant that doesn't set its own value, is current.
-     * The nearest node in the resolved trail that sets it wins, so
-     * `defaultCollapsed: false` on a child re-opens it under a collapsed
-     * parent. Only a default: once the user has toggled the sidebar, their
-     * choice wins everywhere. `AppShell` reads it; `resolveNavigation` copies
-     * it through untouched.
-     *
-     * @stability Beta
-     */
-    defaultCollapsed?: boolean;
-    /**
-     * How the app shell shows this node's `items` (its child pages, e.g. a
-     * form's Questions / Logic / Responses / Settings). `"tabs"` (across the
-     * top of the content) or `"sidebar"` (nested under the active item) turn
-     * shell sub-navigation on, which also gives phones a back item plus the
-     * children in the bottom bar. `"section"` is the legacy rendering (the
-     * shell's default) and `"off"` hides them. The nearest node in the trail
-     * that sets it wins over the shell's `options.subNav`.
-     *
-     * @stability Beta
-     */
-    subNav?: "section" | "tabs" | "sidebar" | "off";
-}
-/**
- * Result of {@link resolveNavigation}. `current`, `parent` and every `trail`
- * entry are shallow copies of their tree nodes with `path` interpolated from
- * `params` (a param the URL did not supply stays as `$name`).
- *
- * @stability Beta
- */
-interface ResolvedNavigation<T> {
-    /** The best-matching node — the root when nothing else matches. */
-    current: NavigationNode<T>;
-    /** `current`'s logical parent, for an "up" / back-to-parent link. */
-    parent?: NavigationNode<T>;
-    /** `current.items`. */
-    items: T[];
-    /** Root → `current`, inclusive. */
-    trail: NavigationNode<T>[];
-    /** Params captured by `current.path`, URL-decoded. */
-    params: Record<string, string>;
-}
-/**
- * Resolve where `pathname` sits in a logical navigation tree. Pure: it never
- * reads browser history or `window`.
- *
- * A node matches when its pattern matches a leading run of WHOLE path
- * segments (`/my` matches `/my/tasks`, never `/my-other`). Among matches the
- * winner is decided by positional specificity: at the first position where
- * one pattern is static and the other a `$param`, the static one wins (so
- * `/clients/new` beats `/clients/$clientId` whatever the sibling order, and
- * `/my` beats `/$space/tasks` for `/my/tasks`). Otherwise the pattern matching
- * more segments wins, then the deeper tree node.
- * Non-matching nodes are still searched, so a match keeps its logical
- * ancestors even when their URLs differ.
- *
- * @stability Beta
- */
-declare function resolveNavigation<T>(tree: NavigationNode<T>, pathname: string): ResolvedNavigation<T>;
-/**
- * Injectable imperative navigation callback.
- *
- * @stability Beta
- */
-type NavigateFn = (path: string) => void;
-/**
- * Default navigate — a full-page navigation. No router required.
- *
- * @stability Beta
- */
-declare const defaultNavigate: NavigateFn;
-/**
- * Minimal, router-agnostic replacement for React Router's `useSearchParams`
- * return shape. Consumers may inject their router's implementation for full
- * SPA integration; otherwise the browser History API is used.
- *
- * @stability Beta
- */
-interface SearchParamsAdapter {
-    searchParams: URLSearchParams;
-    setSearchParams: (next: URLSearchParams, options?: {
-        replace?: boolean;
-    }) => void;
-}
-/**
- * Browser-native {@link SearchParamsAdapter} built on the History API. Reads
- * the current query string and writes updates via `pushState`/`replaceState`,
- * staying reactive to `popstate` events. No router required.
- *
- * @stability Beta
- */
-declare function useBrowserSearchParams(): SearchParamsAdapter;
-
-export { DefaultLink as D, type GenesisLinkProps as G, type IsPathActiveOptions as I, type LinkComponent as L, type NavigationNode as N, type ResolvedNavigation as R, type SearchParamsAdapter as S, type NavigateFn as a, defaultNavigate as d, isPathActive as i, resolveNavigation as r, useBrowserSearchParams as u };

package/dist/slots-tR0wf89f.d.ts

@@ -1,60 +0,0 @@
-import { ComponentType, ReactNode } from 'react';
-
-/**
- * The slot contract — genesis's escape hatch from an all-or-nothing pattern.
- *
- * A pattern component (`ResourcePage`, `DataPageShell`, …) is a composition of
- * interior parts. Without a way to reach those parts, a consumer who needs ONE
- * of them to differ has exactly two options: accept the whole thing as shipped,
- * or fork it. Both are bad, and the second is what actually happens — which is
- * how a downstream app ends up maintaining its own copy of a header it only
- * wanted to change one button in.
- *
- * Genesis offers a customisation ladder, and this is its missing rung:
- *
- *   1. the pattern         `<ResourcePage title="Questions" />`
- *   2. the pattern + slots  ← here: keep the wiring, swap or drop one part
- *   3. the primitives      `<DataPageShell><DataTable/></DataPageShell>`
- *   4. the hook            `useResourcePage()`, render it all yourself
- *
- * Rungs 1, 3 and 4 already existed (75 subpath exports, 9 hooks). Rung 2 is
- * the one that keeps a consumer ON the ladder: dropping to rung 3 because a
- * single part was wrong means re-deriving all the wiring that was already
- * right, and that re-derivation is where the forks come from.
- *
- * Two knobs, following the `slots`/`slotProps` convention Material UI settled
- * on (mui/material-ui#33416) so the shape is one a React developer already
- * knows rather than one genesis invented:
- *
- *   `slots`     — REPLACE a part. Your component receives exactly the props
- *                 genesis would have passed the default, so it can wrap the
- *                 default and change one thing rather than reimplement it.
- *   `slotProps` — KEEP the part, pass it more props. The common case: a
- *                 `className`, a `data-testid`, an `aria-label`.
- *
- * And the eject button: `slots={{ bulkBar: null }}` drops that part entirely.
- * A pattern is a default, not a mandate — a consumer who wants the shell and
- * the grid but none of the bulk bar should not have to leave to get that.
- */
-/** Replace a part (`ComponentType`), or eject it (`null`). */
-type SlotOverride<P> = ComponentType<P> | null;
-/** `{ [part]: Component | null }` — see {@link renderSlot}. */
-type Slots<M extends Record<string, object>> = {
-    [K in keyof M]?: SlotOverride<M[K]>;
-};
-/** `{ [part]: extraProps }` — merged over what genesis passes. */
-type SlotPropsFor<M extends Record<string, object>> = {
-    [K in keyof M]?: Partial<M[K]>;
-};
-/**
- * Renders one slot: the override if given, the default otherwise, nothing if
- * ejected with `null`.
- *
- * `extra` merges LAST, so `slotProps` wins over genesis's own value. That is
- * deliberate: a consumer reaching for `slotProps` is overriding on purpose,
- * and a hatch that silently loses to the default is not a hatch. `className`
- * is the one prop a caller should merge with `cn()` instead of replacing.
- */
-declare function renderSlot<P extends object>(Default: ComponentType<P>, override: SlotOverride<P> | undefined, props: P, extra?: Partial<P>): ReactNode;
-
-export { type SlotOverride as S, type SlotPropsFor as a, type Slots as b, renderSlot as r };