@ubx/docs-ui 0.8.0 → 0.9.0

package/dist/PageShell.d.ts

@@ -53,6 +53,19 @@ export type PageShellProps = {
     showThemeToggle?: boolean;
     /** See Header's own githubUrl. Omitted means no button. */
     githubUrl?: string;
+    /**
+     * Render children edge to edge, with no centred, padded main column.
+     *
+     * The default wraps children in `mx-auto max-w-7xl px-6 py-12`, which
+     * is right for a docs page and wrong for a page built from full bleed
+     * tone bands: it caps every band at 1280px and insets it 24px, so the
+     * bands stop reaching the viewport edges and the alternating tones
+     * read as boxes rather than bands.
+     *
+     * ubiquex.io's home page is built that way, so it opts out and owns
+     * its own inner width. Both docs sites are unaffected.
+     */
+    fullBleed?: boolean;
     /** Footer identity. Required for the reason stated on Footer itself. */
     footer: {
         tagline: React.ReactNode;
@@ -63,7 +76,7 @@ export type PageShellProps = {
     };
     children: React.ReactNode;
 };
-export declare function PageShell({ nav, tabs, activeTab, sidebar, sidebarLabel, searchPlaceholder, searchPlacement, intro, showThemeToggle, githubUrl, footer, children, }: PageShellProps): React.JSX.Element;
+export declare function PageShell({ nav, tabs, activeTab, sidebar, sidebarLabel, searchPlaceholder, searchPlacement, intro, showThemeToggle, githubUrl, fullBleed, footer, children, }: PageShellProps): React.JSX.Element;
 /**
  * Sets data-theme from localStorage before paint.
  *

package/dist/PageShell.js

@@ -9,13 +9,13 @@ const HEADER_SEARCH_CLASS = "w-full rounded-full bg-field px-4 py-1.5 text-sm te
 /** Full size, for a landing page where search is the point. */
 const HERO_SEARCH_CLASS = "w-full rounded-full bg-field px-5 py-3 text-base text-foreground outline-none " +
     "placeholder:text-foreground-muted focus:ring-2 focus:ring-primary/30";
-export function PageShell({ nav, tabs, activeTab, sidebar, sidebarLabel = "Navigation", searchPlaceholder, searchPlacement = "header", intro, showThemeToggle = true, githubUrl, footer, children, }) {
+export function PageShell({ nav, tabs, activeTab, sidebar, sidebarLabel = "Navigation", searchPlaceholder, searchPlacement = "header", intro, showThemeToggle = true, githubUrl, fullBleed = false, footer, children, }) {
     const headerSearch = searchPlaceholder && searchPlacement === "header" ? (_jsx(GlobalSearch, { placeholder: searchPlaceholder, inputClassName: HEADER_SEARCH_CLASS })) : undefined;
     const heroSearch = searchPlaceholder && searchPlacement === "hero" ? (_jsx("div", { className: "mx-auto mt-8 max-w-xl", children: _jsx(GlobalSearch, { placeholder: searchPlaceholder, inputClassName: HERO_SEARCH_CLASS }) })) : null;
     return (_jsxs(_Fragment, { children: [_jsx(Header, { nav: nav, tabs: tabs, activeTab: activeTab, search: headerSearch, showThemeToggle: showThemeToggle, githubUrl: githubUrl, mobileMenu: sidebar ? (_jsx(MobileSidebarToggle, { label: sidebarLabel, children: sidebar })) : undefined }), sidebar ? (
             // No intro or hero search here on purpose: a page with a sidebar
             // is a content page, and a hero belongs to a landing page.
-            _jsxs("div", { className: "mx-auto flex w-full max-w-7xl flex-1 gap-10 px-6 py-10", children: [_jsx("aside", { className: "hidden w-64 shrink-0 lg:block", children: sidebar }), _jsx("main", { className: "min-w-0 flex-1", children: children })] })) : (_jsxs("main", { className: "mx-auto w-full max-w-7xl flex-1 px-6 py-12", children: [intro, heroSearch, children] })), _jsx(Footer, { tagline: footer.tagline, links: footer.links })] }));
+            _jsxs("div", { className: "mx-auto flex w-full max-w-7xl flex-1 gap-10 px-6 py-10", children: [_jsx("aside", { className: "hidden w-64 shrink-0 lg:block", children: sidebar }), _jsx("main", { className: "min-w-0 flex-1", children: children })] })) : fullBleed ? (_jsxs("main", { className: "flex-1", children: [intro, heroSearch, children] })) : (_jsxs("main", { className: "mx-auto w-full max-w-7xl flex-1 px-6 py-12", children: [intro, heroSearch, children] })), _jsx(Footer, { tagline: footer.tagline, links: footer.links })] }));
 }
 /**
  * Sets data-theme from localStorage before paint.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubx/docs-ui",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Shared UI for ubx documentation sites: the page shell, theme A, Shiki-backed CodeBlock, header, search, theme toggle.",
   "license": "Apache-2.0",
   "type": "module",