@danxbot/ui 3.3.0 → 3.4.0

package/dist/types/components/AppShell.d.ts

@@ -52,7 +52,45 @@ export interface AppShellProps {
      * @default "Main"
      */
     navLabel?: string;
+    /**
+     * Which box scrolls when the content is taller than the screen.
+     *
+     * `"content"` — the default, and what an application shell IS. The shell is
+     * exactly the viewport, the header and sidebar are fixed by structure, and
+     * the content column scrolls itself. A screen that wants to fill the height
+     * it has been given writes `flex-1 min-h-0` and never names a viewport unit
+     * or one of this library's tokens.
+     *
+     * `"document"` — the shell grows with its content and the PAGE scrolls, with
+     * the header and sidebar stuck to the top. For a shell embedded in a longer
+     * document, or a page whose content genuinely wants the browser's own
+     * scrollbar. It is the opt-out rather than the default, deliberately: the
+     * bounded arrangement is the one nobody has to compute anything for, and a
+     * default that made consumers subtract a header height from `100dvh` is what
+     * this prop exists to have stopped.
+     *
+     * @default "content"
+     */
+    scroll?: "content" | "document";
+    /**
+     * Change this to send the content back to the top — a route path, a record
+     * id, whatever identifies "a different screen is showing now".
+     *
+     * IT EXISTS BECAUSE BOUNDING THE SHELL MOVED THE SCROLLER. Every routed
+     * application resets the scroll on navigation, and while the DOCUMENT was
+     * the scroller they all wrote `window.scrollTo({ top: 0 })`. That line is
+     * inert here: the window no longer scrolls, so a route change would leave
+     * the new screen opened halfway down with nothing to indicate why.
+     *
+     * The alternative was to hand out a ref and let each consumer scroll it,
+     * which is the same work in every application plus a piece of this
+     * component's internals in all of them. The scroller stays private; the
+     * element also carries `data-app-shell-content` for the rarer jobs — scroll
+     * restoration on a back navigation, an intersection observer — that need the
+     * box itself.
+     */
+    scrollResetKey?: string | number;
     children: ReactNode;
     className?: string;
 }
-export declare function AppShell({ brand, sections, activeId, sidebarFooter, header, contentLandmark, navLabel, children, className, }: AppShellProps): import("react").JSX.Element;
+export declare function AppShell({ brand, sections, activeId, sidebarFooter, header, contentLandmark, navLabel, scroll, scrollResetKey, children, className, }: AppShellProps): import("react").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/ui",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "type": "module",
   "description": "Danxbot — a domain-agnostic React design system with motion as a first-class primitive.",
   "license": "MIT",
@@ -69,7 +69,7 @@
     "gates": "npm run shoot && npm run a11y && node scripts/shoot-overlays.mjs && npm run probe",
     "a11y": "node scripts/a11y-scan.mjs",
     "shoot": "node scripts/shoot.mjs",
-    "probe": "node scripts/probe-scale.mjs && node scripts/probe-switch.mjs && node scripts/probe-slider.mjs && node scripts/probe-panel.mjs && node scripts/probe-popover-width.mjs && node scripts/probe-api.mjs && node scripts/probe-api-live.mjs && node scripts/probe-tabs-overflow.mjs && node scripts/probe-stat-row.mjs && node scripts/probe-packaging.mjs && node scripts/probe-containment.mjs",
+    "probe": "node scripts/probe-scale.mjs && node scripts/probe-switch.mjs && node scripts/probe-slider.mjs && node scripts/probe-panel.mjs && node scripts/probe-popover-width.mjs && node scripts/probe-api.mjs && node scripts/probe-api-live.mjs && node scripts/probe-tabs-overflow.mjs && node scripts/probe-stat-row.mjs && node scripts/probe-packaging.mjs && node scripts/probe-containment.mjs && node scripts/probe-shell.mjs",
     "sync": "node scripts/sync.mjs",
     "visual": "node scripts/visual-docker.mjs",
     "visual:update": "node scripts/visual-docker.mjs --update-snapshots",