@colixsystems/widget-sdk 0.79.0 → 0.80.0

package/README.md

@@ -26,6 +26,8 @@ The data layer lives in **four separate domain-client packages**, each instantia
 | **CORE** | `useWidgetEvent(name)` | `(payload?) => void` | `ctx.events.emit` — no scope |
 | **CORE** | `useChildRenderer()` | `{ renderNode(node) }` | `ctx.renderer` — no scope (prefer the `WidgetTree` component) |
 | **CORE** | `useFill()` | `boolean` | `ctx.fill` — no scope. `true` when the host sized this widget to fill its page-grid tile's reserved height (containers + media fill by default; the author can override per tile). Media-style widgets switch to a `flex: 1` / `height: "100%"` layout; others ignore it. Defaults `false`. |
+| **CORE** | `useContainerWidth()` | `[width, onLayout]` | No context slice, no scope. Measures the width the widget's OWN box has, so it can lay itself out for the space it is in rather than for the screen. Spread the handler onto your outermost primitive. Use it for any widget with a wide form and a narrow one (a table, a toolbar, a row of tiles) — never switch on the device or window width, because a widget in a one-of-three grid cell on desktop has phone-width room and a widget filling a phone page does not. Width is 0 until the first layout: render the WIDE form then. One implementation covers web (react-native-web) and the native export. |
+| **CORE** | `isNarrowWidth(width)` | `boolean` | No context slice, no scope. True when a MEASURED width is below `NARROW_WIDTH_PX` (480) — the one threshold every widget switches at, so a page reflows together rather than raggedly. An unmeasured width (0) is NOT narrow, so nothing flashes through the narrow form on first paint. |
 | **CORE** | `useSectionEmpty(isEmpty)` | `void` | `ctx.section.reportEmpty` — no scope. Declares that the widget has NO content to show, so the host drops its layout slot instead of reserving space (and its parent's `gap`) for it. Returning `null` is not enough: the host wraps every widget in an entrance element, so a widget rendering nothing still leaves an empty box the parent stack gaps around. For a CONDITIONALLY ABSENT section (a per-record child collection with no rows for this record), never to suppress a genuine empty state. Stays mounted while collapsed, so passing `false` brings it back. Authoring surfaces never collapse. No-op on a host that doesn't implement it. |
 | **CORE** | `useRefresh(handler)` | `void` | `ctx.refresh.subscribe` — no scope. Subscribes the handler to the page-level refresh tick (pull-to-refresh on mobile). Handler may return a Promise — the host waits for `allSettled` before clearing the spinner. The three datastore hooks auto-subscribe their own `refetch`; widgets only call this directly to re-run non-datastore work. No-op on a host that doesn't implement refresh. |
 | **CORE** | `useClipboard()` | `{ copy, paste, hasContent }` | platform clipboard (web `navigator.clipboard` / native `expo-clipboard`); rejects with `ClipboardError` — no scope |
@@ -302,6 +304,8 @@ useEffect(() => {
 
 ### What's new in 0.41.0
 
+**New `useContainerWidth()` hook + `isNarrowWidth(width)` / `NARROW_WIDTH_PX` (sc-4399).** A widget can now measure the width of its OWN box and lay itself out for the space it is in. This is the capability that was missing for every widget except Gallery, which had hand-rolled the same `onLayout` measurement for its carousel — that copy is now gone and Gallery reads the hook. It matters because the screen is the wrong question: a widget in a one-of-three grid cell on a desktop page has phone-width room, and a widget filling a phone page does not, so a table-shaped widget that switches on the device is wrong in both directions. `isNarrowWidth` gives every widget one threshold (480) to switch at, so a page of them reflows together instead of raggedly, and an unmeasured width (0) is deliberately not narrow so nothing flashes through its narrow form on first paint. `onLayout` is a react-native primitive callback, so ONE implementation serves the web Player and the exported app. Additive — `CONTRACT.version` bumped to the next minor for two new hooks.
+
 **New `useSectionEmpty(isEmpty)` hook + optional `ctx.section` slice (sc-4416).** A widget can now tell the host it has no content to show, and the host removes its layout slot rather than reserving space for it. This closes a gap that `null` alone could not: the host wraps every widget node in an entrance element, so a widget that rendered nothing still left an empty box its parent stack put `gap` around — a dead band of whitespace exactly where the content would have been. It matters most for a per-record child collection (a policy detail page whose quiz section only exists for policies that have questions): the widget owns the rows, so only the widget can say, and `visibleWhen` cannot reach it because "has related rows" is not a field the record carries. The widget stays MOUNTED while collapsed, so when rows arrive it reports `false` and the section returns on its own — no measurement, no second pass. The slot (`ctx.section.reportEmpty`) is optional and deliberately omitted on authoring surfaces: on the Studio canvas and in the Agent Mode edit preview an empty widget must stay visible and selectable, or an absent section could never be edited. Additive — `CONTRACT.version` bumped to the next minor for a new hook plus a new optional context slice.
 
 **New `useRefresh(handler)` hook + page-level refresh signal (sc-1179).** Pull-to-refresh on the mobile web Player + the native Expo export's `RefreshControl` now fans a page-level refresh tick out to every widget on the page. The three datastore hooks — `useDatastoreQuery`, `useDatastoreRecord`, `useAsset` — auto-subscribe their own `refetch`, so a widget built on those hooks gets refreshed for free. Widgets that need to re-run other work (a third-party `fetch`, a derived calculation) call `useRefresh(async () => { … })` directly. The handler may return a Promise — the host waits on `Promise.allSettled` of every subscriber before clearing the spinner. The slot (`ctx.refresh.subscribe`) is optional on the WidgetContext: a host that does not implement refresh (the Studio canvas preview) simply omits it and the hook collapses to a no-op. Additive — `CONTRACT.version` bumped to the next minor since the contract grew a new hook + a new (optional) context slice.

package/dist/container-width.js

@@ -0,0 +1,28 @@
+// sc-4399 — the narrow-form threshold, in its own dependency-free module.
+//
+// Deliberately NOT in hooks.js: that file's test harnesses load it through a
+// hand-rolled transform that only understands `export function`, so an
+// `export const` there breaks every hooks test at once. Keeping the constant
+// here also means a consumer that just wants the number pays no React import.
+//
+// `useContainerWidth` itself stays in hooks.js, where React is already
+// imported — it is the hook that measures; these two only classify.
+
+/**
+ * The width below which a widget should adopt its narrow form — a table
+ * becomes stacked label/value blocks, a toolbar wraps. ONE number so a page of
+ * widgets reflows together instead of raggedly.
+ */
+export const NARROW_WIDTH_PX = 480;
+
+/**
+ * True when a MEASURED width is below the threshold.
+ *
+ * An unmeasured width (0, before the first `onLayout`) is deliberately NOT
+ * narrow: the wide rendering is the historical one, so a widget that never
+ * lays out is unchanged, and no widget flashes through its narrow form on
+ * first paint.
+ */
+export function isNarrowWidth(width) {
+  return typeof width === "number" && width > 0 && width < NARROW_WIDTH_PX;
+}

package/dist/contract.cjs

@@ -358,6 +358,45 @@ const HOOKS = [
     requiredContextSlice: ["refresh.subscribe"],
     scopes: null,
   },
+  {
+    name: "useContainerWidth",
+    signature: "useContainerWidth()",
+    description:
+      "Measure the width the widget's OWN box has, so it can lay itself out " +
+      "for the space it is in rather than for the screen. Returns " +
+      "`[width, onLayout]`; spread the handler onto the widget's outermost " +
+      "primitive. A widget in a 1-of-3 grid cell on a desktop page has " +
+      "phone-width room while a widget filling a phone page does not, and the " +
+      "window width answers neither question — this is why a table-shaped " +
+      "widget must not switch on the device. `onLayout` is the react-native " +
+      "callback, so ONE implementation serves the web Player (through " +
+      "react-native-web) and the native export. Before the first layout the " +
+      "width is 0: treat that as \"not yet measured\" and render the wide " +
+      "form. Pair it with `isNarrowWidth(width)` so every widget switches at " +
+      "the same threshold. Takes no host context, so it is safe everywhere " +
+      "including the Studio canvas.",
+    returnShape: {
+      "(returns)": "[number, function]",
+    },
+    requiredContextSlice: [],
+    scopes: null,
+  },
+  {
+    name: "isNarrowWidth",
+    signature: "isNarrowWidth(width)",
+    description:
+      "True when a MEASURED width is below `NARROW_WIDTH_PX` (480), the one " +
+      "threshold at which a widget adopts its narrow form — a table becomes " +
+      "stacked cards, a toolbar wraps. One number so a page of widgets " +
+      "reflows together instead of raggedly. An unmeasured width (0) is " +
+      "deliberately NOT narrow, so a widget that never lays out keeps its " +
+      "historical wide rendering.",
+    returnShape: {
+      "(returns)": "boolean",
+    },
+    requiredContextSlice: [],
+    scopes: null,
+  },
   {
     name: "useSectionEmpty",
     signature: "useSectionEmpty(isEmpty)",
@@ -2406,7 +2445,15 @@ const CONTRACT = deepFreeze({
   //    public endpoint instead, which skips the cache, the metering and the
   //    workspace's provider. Publishing the host list here keeps the linter,
   //    the Developer guide and the agent prompt reading one source.
-  version: "1.53.0",
+  // 1.54.0: additive (sc-4399, epic 4395) — `useContainerWidth()` +
+  //    `isNarrowWidth(width)` / `NARROW_WIDTH_PX`. Built-in widgets laid
+  //    themselves out at a fixed size — UserManagement's rows alone carried
+  //    ~800px of minWidth — so a page that reflowed around them still
+  //    overflowed, because the widget inside demanded desktop width. Gallery
+  //    already measured its own box with onLayout; this promotes that one
+  //    pattern to the SDK so custom and marketplace widgets get it too,
+  //    instead of each rolling its own.
+  version: "1.54.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/contract.js

@@ -358,6 +358,45 @@ const HOOKS = [
     requiredContextSlice: ["refresh.subscribe"],
     scopes: null,
   },
+  {
+    name: "useContainerWidth",
+    signature: "useContainerWidth()",
+    description:
+      "Measure the width the widget's OWN box has, so it can lay itself out " +
+      "for the space it is in rather than for the screen. Returns " +
+      "`[width, onLayout]`; spread the handler onto the widget's outermost " +
+      "primitive. A widget in a 1-of-3 grid cell on a desktop page has " +
+      "phone-width room while a widget filling a phone page does not, and the " +
+      "window width answers neither question — this is why a table-shaped " +
+      "widget must not switch on the device. `onLayout` is the react-native " +
+      "callback, so ONE implementation serves the web Player (through " +
+      "react-native-web) and the native export. Before the first layout the " +
+      "width is 0: treat that as \"not yet measured\" and render the wide " +
+      "form. Pair it with `isNarrowWidth(width)` so every widget switches at " +
+      "the same threshold. Takes no host context, so it is safe everywhere " +
+      "including the Studio canvas.",
+    returnShape: {
+      "(returns)": "[number, function]",
+    },
+    requiredContextSlice: [],
+    scopes: null,
+  },
+  {
+    name: "isNarrowWidth",
+    signature: "isNarrowWidth(width)",
+    description:
+      "True when a MEASURED width is below `NARROW_WIDTH_PX` (480), the one " +
+      "threshold at which a widget adopts its narrow form — a table becomes " +
+      "stacked cards, a toolbar wraps. One number so a page of widgets " +
+      "reflows together instead of raggedly. An unmeasured width (0) is " +
+      "deliberately NOT narrow, so a widget that never lays out keeps its " +
+      "historical wide rendering.",
+    returnShape: {
+      "(returns)": "boolean",
+    },
+    requiredContextSlice: [],
+    scopes: null,
+  },
   {
     name: "useSectionEmpty",
     signature: "useSectionEmpty(isEmpty)",
@@ -2406,7 +2445,15 @@ const CONTRACT = deepFreeze({
   //    public endpoint instead, which skips the cache, the metering and the
   //    workspace's provider. Publishing the host list here keeps the linter,
   //    the Developer guide and the agent prompt reading one source.
-  version: "1.53.0",
+  // 1.54.0: additive (sc-4399, epic 4395) — `useContainerWidth()` +
+  //    `isNarrowWidth(width)` / `NARROW_WIDTH_PX`. Built-in widgets laid
+  //    themselves out at a fixed size — UserManagement's rows alone carried
+  //    ~800px of minWidth — so a page that reflowed around them still
+  //    overflowed, because the widget inside demanded desktop width. Gallery
+  //    already measured its own box with onLayout; this promotes that one
+  //    pattern to the SDK so custom and marketplace widgets get it too,
+  //    instead of each rolling its own.
+  version: "1.54.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/hooks.js

@@ -289,6 +289,38 @@ export function useSectionEmpty(isEmpty) {
   }, [empty]);
 }
 
+/**
+ * sc-4399 — measure the width the widget's own box actually has, so it can lay
+ * itself out for the space it is in rather than for the screen. A widget in a
+ * 1-of-3 grid cell on a desktop page has phone-width room; a widget filling a
+ * phone page does not. The window width answers neither question.
+ *
+ * Spread the returned handler onto the widget's outermost primitive:
+ *
+ *   const [width, onLayout] = useContainerWidth();
+ *   return <View onLayout={onLayout}>{isNarrowWidth(width) ? <Cards/> : <Table/>}</View>;
+ *
+ * `onLayout` is the react-native primitive callback, so ONE implementation
+ * serves the web Player (through react-native-web) and the native export.
+ * Before the first layout the width is 0 — treat that as "not yet measured"
+ * and render the wide form, which is what `isNarrowWidth`
+ * (./container-width.js) does.
+ *
+ * Takes no context, so it is safe on every host including the Studio canvas.
+ */
+export function useContainerWidth() {
+  const [width, setWidth] = useState(0);
+  const onLayout = useCallback((event) => {
+    const next =
+      event && event.nativeEvent && event.nativeEvent.layout
+        ? event.nativeEvent.layout.width
+        : undefined;
+    if (typeof next !== "number" || !(next > 0)) return;
+    setWidth((prev) => (prev === next ? prev : next));
+  }, []);
+  return [width, onLayout];
+}
+
 /**
  * Returns the host-provided navigation surface:
  *   `{ goTo, goBack, push, replace, back, currentRoute }`.

package/dist/index.d.ts

@@ -1110,6 +1110,34 @@ export function useRefresh(
  */
 export function useSectionEmpty(isEmpty: boolean): void;
 
+/** The layout event a react-native primitive passes to `onLayout`. */
+export interface WidgetLayoutEvent {
+  nativeEvent: { layout: { width: number; height: number; x: number; y: number } };
+}
+
+/**
+ * sc-4399 — measure the width the widget's OWN box has, so it can lay itself
+ * out for the space it is in rather than for the screen. Spread the returned
+ * handler onto the widget's outermost primitive; ONE implementation serves the
+ * web Player (via react-native-web) and the native export. The width is 0
+ * before the first layout — treat that as "not yet measured" and render the
+ * wide form, which is what `isNarrowWidth` does.
+ */
+export function useContainerWidth(): [
+  number,
+  (event: WidgetLayoutEvent) => void,
+];
+
+/** The width below which a widget should adopt its narrow form (480). */
+export const NARROW_WIDTH_PX: number;
+
+/**
+ * True when a MEASURED width is below `NARROW_WIDTH_PX`. An unmeasured width
+ * (0) is deliberately NOT narrow, so a widget that never lays out keeps its
+ * historical wide rendering.
+ */
+export function isNarrowWidth(width: number): boolean;
+
 /** Pass-through options for `useGeolocation().getCurrentPosition(...)`. */
 export interface GeolocationOptions {
   enableHighAccuracy?: boolean;

package/dist/index.js

@@ -51,10 +51,12 @@ export {
   useChildRenderer,
   useRefresh,
   useSectionEmpty,
+  useContainerWidth,
   useGeolocation,
   GeolocationError,
   WidgetTree,
 } from "./hooks.js";
+export { isNarrowWidth, NARROW_WIDTH_PX } from "./container-width.js";
 // REQ-WSDK-PLATFORM §6 — Tier A hooks. Each ships in a per-platform file
 // (./clipboard.js / .native.js, ./toast.js / .native.js); index.js picks
 // the web variant and index.native.js picks the native variant.

package/dist/index.native.js

@@ -51,10 +51,12 @@ export {
   useChildRenderer,
   useRefresh,
   useSectionEmpty,
+  useContainerWidth,
   useGeolocation,
   GeolocationError,
   WidgetTree,
 } from "./hooks.js";
+export { isNarrowWidth, NARROW_WIDTH_PX } from "./container-width.js";
 // REQ-WSDK-PLATFORM §6 — Tier A hooks (native variants).
 export { useClipboard, ClipboardError } from "./clipboard.native.js";
 export { useToast } from "./toast.native.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.79.0",
+  "version": "0.80.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "type": "module",
   "main": "./dist/index.js",