@multiplatform.one/components 7.79.0 → 7.81.0

package/types/layouts/screenScroll.d.ts

@@ -112,6 +112,30 @@ export declare function TopBarSlot({ children, ...value }: TopBarSlotValue & {
 }): import("react/jsx-runtime").JSX.Element;
 /** The pinned top bar's slot, or null when a toolbar sits in the page flow. */
 export declare function useTopBarSlot(): TopBarSlotValue | null;
+/**
+ * What the outermost Screen under an app shell tells the shell's nav bar
+ * (LC-157 under `AppShell`): its scroll state, and whether the page pins a
+ * top bar of its own, in which case that bar is the nav bar and the shell
+ * draws none.
+ */
+export interface ShellScrollReport extends ScreenScrollState {
+    ownTopBar: boolean;
+}
+type ShellScrollReporter = (id: string, report: ShellScrollReport | null) => void;
+/** The shell's half: the latest report, and the scope its content sits in. */
+export declare function useShellScrollReports(): {
+    report: ShellScrollReport | null;
+    reporter: ShellScrollReporter;
+};
+export declare function ShellScrollReportScope({ reporter, children, }: {
+    reporter: ShellScrollReporter;
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * The Screen's half: the outermost Screen under a shell reports its state;
+ * a Screen nested in another stays quiet, so the page's own wins.
+ */
+export declare function useReportScreenScroll(state: ScreenScrollState, ownTopBar: boolean): void;
 /**
  * A nested Screen's content scrolls in its parent's scroll view, so it reads
  * the parent's scroll actions, but its own large title stays a heading in the

package/types/layouts/screenScroll.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screenScroll.d.ts","sourceRoot":"","sources":["../../src/layouts/screenScroll.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAclD,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,QAAQ,EAAE,OAAO,CAAC;IAClB,qEAAqE;IACrE,SAAS,EAAE,OAAO,CAAC;IACnB,0EAA0E;IAC1E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,UAAU,mBAAmB;IAC3B,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,+BAA+B;IAC/B,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,iDAAiD;IACjD,MAAM,EAAE,MAAM,MAAM,CAAC;IACrB,uEAAuE;IACvE,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,IAAI,CAAC;IAC7C,0EAA0E;IAC1E,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1C;AAYD,UAAU,eAAe;IACvB,WAAW,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE;YAAE,CAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IACjD,MAAM,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,aAAa,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxC;AAED,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAOhE;AAED,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC3C,wEAAwE;IACxE,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,qEAAqE;IACrE,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,KAAK,EAAE,iBAAiB,CAAC;IACzB,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,sBAAsB,CAmDlE;AAED,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,EAChC,UAAU,EACV,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,sBAAsB,CAAC;IACnC,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAQA;AAED,8EAA8E;AAC9E,wBAAgB,eAAe,IAAI,iBAAiB,CAEnD;AAyBD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,UAAO;iBA+BrC,OAAO;;;;;;;EAKxC;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEvE;AAOD;;;;;;;GAOG;AACH,wBAAgB,YAAY;iBAGM,OAAO;;EA6BxC;AAED,UAAU,eAAe;IACvB,uDAAuD;IACvD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAID,oDAAoD;AACpD,wBAAgB,UAAU,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,EAAE,eAAe,GAAG;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAM3F;AAED,+EAA+E;AAC/E,wBAAgB,aAAa,IAAI,eAAe,GAAG,IAAI,CAEtD;AAKD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAatE"}
+{"version":3,"file":"screenScroll.d.ts","sourceRoot":"","sources":["../../src/layouts/screenScroll.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAclD,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,QAAQ,EAAE,OAAO,CAAC;IAClB,qEAAqE;IACrE,SAAS,EAAE,OAAO,CAAC;IACnB,0EAA0E;IAC1E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,UAAU,mBAAmB;IAC3B,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,+BAA+B;IAC/B,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,iDAAiD;IACjD,MAAM,EAAE,MAAM,MAAM,CAAC;IACrB,uEAAuE;IACvE,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,IAAI,CAAC;IAC7C,0EAA0E;IAC1E,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1C;AAYD,UAAU,eAAe;IACvB,WAAW,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE;YAAE,CAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IACjD,MAAM,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,aAAa,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxC;AAED,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAOhE;AAED,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC3C,wEAAwE;IACxE,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAChC,qEAAqE;IACrE,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7B,KAAK,EAAE,iBAAiB,CAAC;IACzB,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,sBAAsB,CAmDlE;AAED,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,EAChC,UAAU,EACV,QAAQ,GACT,EAAE;IACD,UAAU,EAAE,sBAAsB,CAAC;IACnC,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAQA;AAED,8EAA8E;AAC9E,wBAAgB,eAAe,IAAI,iBAAiB,CAEnD;AAyBD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,UAAO;iBA+BrC,OAAO;;;;;;;EAKxC;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEvE;AAOD;;;;;;;GAOG;AACH,wBAAgB,YAAY;iBAGM,OAAO;;EA6BxC;AAED,UAAU,eAAe;IACvB,uDAAuD;IACvD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAID,oDAAoD;AACpD,wBAAgB,UAAU,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,EAAE,eAAe,GAAG;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAM3F;AAED,+EAA+E;AAC/E,wBAAgB,aAAa,IAAI,eAAe,GAAG,IAAI,CAEtD;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,KAAK,mBAAmB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,IAAI,KAAK,IAAI,CAAC;AAIlF,8EAA8E;AAC9E,wBAAgB,qBAAqB,IAAI;IACvC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,mBAAmB,CAAC;CAC/B,CAkBA;AAED,wBAAgB,sBAAsB,CAAC,EACrC,QAAQ,EACR,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAMA;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,OAAO,QAajF;AAKD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAatE"}

package/types/layouts/sidebar.d.ts

@@ -55,7 +55,43 @@ export interface SidebarProps {
      * most half the rail, so the sections always keep the other half.
      */
     footer?: React.ReactNode;
+    /**
+     * Take the height of the rows instead of the column's: a rail inside a sheet
+     * that sizes to its content. The container owns scrolling, so the rail draws
+     * no scroller of its own and its footer follows the rows.
+     */
+    hug?: boolean;
     testID?: string;
+    /** Pinned above the rows, outside their scroll (an app's name in a shell rail). */
+    header?: React.ReactNode;
+    /** Stacked under the sections inside the same scroll (a page's panel, LC-101). */
+    children?: React.ReactNode;
+    /**
+     * Paint the column in the translucent sidebar material instead of the card
+     * surface (the HIG source list): an app shell's sidebar.
+     */
+    material?: boolean;
 }
-export declare function Sidebar({ sections, width, "aria-label": ariaLabel, role, divider, footer, testID, }: SidebarProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * The ramp step the sidebar material paints: darker than the page in light,
+ * lighter in dark, as the HIG sidebar reads against its content. The dark
+ * ramp climbs slower at its low end, so it takes one step more.
+ */
+export declare const sidebarMaterial: {
+    readonly light: "$color3";
+    readonly dark: "$color4";
+};
+/**
+ * How much of the page shows through the material. The shell's column sits
+ * beside its content, never over it, so the page ground is all that is
+ * behind it and a blur would paint nothing (LC-206).
+ */
+export declare const sidebarMaterialOpacity = 0.72;
+/**
+ * A material rail's inset from its edges. Its rows are inset pills with no
+ * rule between them (the HIG source list); a header or footer lines up with
+ * the rows by it.
+ */
+export declare const sidebarRailInset = "$2";
+export declare function Sidebar({ sections, width, "aria-label": ariaLabel, role, divider, footer, hug, testID, header, children, material, }: SidebarProps): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=sidebar.d.ts.map

package/types/layouts/sidebar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sidebar.d.ts","sourceRoot":"","sources":["../../src/layouts/sidebar.tsx"],"names":[],"mappings":"AAYA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAO/B,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,8DAA8D;IAC9D,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC;IACtC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,OAAO,CAAC,EACtB,QAAQ,EACR,KAAW,EACX,YAAY,EAAE,SAAqB,EACnC,IAAmB,EACnB,OAAc,EACd,MAAM,EACN,MAAM,GACP,EAAE,YAAY,2CAyPd"}
+{"version":3,"file":"sidebar.d.ts","sourceRoot":"","sources":["../../src/layouts/sidebar.tsx"],"names":[],"mappings":"AAcA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAiB/B,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,8DAA8D;IAC9D,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACvB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC;IACtC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB;;;;OAIG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mFAAmF;IACnF,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACzB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;CAAiD,CAAC;AAC9E;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAqBrC,wBAAgB,OAAO,CAAC,EACtB,QAAQ,EACR,KAAW,EACX,YAAY,EAAE,SAAqB,EACnC,IAAmB,EACnB,OAAc,EACd,MAAM,EACN,GAAW,EACX,MAAM,EACN,MAAM,EACN,QAAQ,EACR,QAAgB,GACjB,EAAE,YAAY,2CAgRd"}