@colixsystems/widget-sdk 0.230.0 → 0.231.0

package/README.md

@@ -84,7 +84,34 @@ See the design reference for the full architecture: [`docs/architecture/widget-m
 
 ## Status
 
-`v0.230.0` — pre-publish. The package surface (types, function names, export paths) is the v1 contract; runtime behaviour for some hooks is stubbed (each hook documents what's wired and what isn't). It is **not yet published to npm**.
+`v0.231.0` — pre-publish. The package surface (types, function names, export paths) is the v1 contract; runtime behaviour for some hooks is stubbed (each hook documents what's wired and what isn't). It is **not yet published to npm**.
+
+### What's new in 0.231.0 (contract 1.186.0)
+
+**A whole-screen widget can run to the bottom edge of a phone — `useFitScreenInsets()`.** In the exported app, a Fit to screen section whose widget scrolls itself (`prefersFitToScreen: true`) and calls the new `useFitScreenInsets()` runs all the way to the screen's bottom edge, under the iPhone home indicator or the Android navigation bar, so your widget's background fills the screen with no strip of page colour below it. Keep your bottom-anchored controls clear of that area with the new `useFitScreenInsets()`: it returns `{ top, right, bottom, left }` in px, the parts of the device's safe area your surface runs under. Pad your composer, a pinned bar or the end of a list by `bottom`, with your background behind the padding.
+
+```jsx
+import * as sdk from "@colixsystems/widget-sdk";
+import { View, TextInput } from "@colixsystems/widget-sdk";
+
+// A host older than 0.231.0 has no useFitScreenInsets.
+const NO_INSETS = { top: 0, right: 0, bottom: 0, left: 0 };
+const useFitScreenInsets =
+  typeof sdk.useFitScreenInsets === "function" ? sdk.useFitScreenInsets : () => NO_INSETS;
+
+function ComposerBar({ theme }) {
+  const { bottom } = useFitScreenInsets();
+  return (
+    <View style={{ backgroundColor: theme.colors.surface, padding: 10, paddingBottom: 10 + bottom }}>
+      <TextInput placeholder="Message" />
+    </View>
+  );
+}
+```
+
+The host decides the value, so you never subtract anything yourself: it is `0` while the keyboard is up (the keyboard covers that area, and your composer sits right on it), when the app's bottom bar already holds the inset, on web (the browser keeps the page inside its own safe area), and for every widget that is not a self-scrolling fit surface ending the page. Calling the hook is the opt-in: a widget that never calls it, or does not scroll itself, keeps the inset below its section, as before, so an existing widget's controls never move under the indicator. Nor does a widget with something drawn below it inside the section, such as a bottom tab bar. Use this hook rather than `useSafeAreaInsets()` from `react-native-safe-area-context`: the device's raw inset would also pad a composer that sits on a bottom bar or on the keyboard.
+
+Additive: a host without the `fitScreenFoot` hint reads zeros, so a widget that pads by it looks exactly as before there.
 
 ### What's new in 0.230.0 (contract 1.185.0)
 

package/dist/contract.cjs

@@ -1021,6 +1021,31 @@ const HOOKS = [
     requiredContextSlice: ["fitScreen"],
     scopes: null,
   },
+  {
+    name: "useFitScreenInsets",
+    signature: "useFitScreenInsets()",
+    description:
+      "Returns { top, right, bottom, left } in px: the parts of the device's " +
+      "safe area (the home indicator, a system navigation bar) that this " +
+      "widget's surface runs under. Calling it opts the widget in: only then " +
+      "does a Fit to screen section whose widget scrolls itself (manifest " +
+      "prefersFitToScreen) run to the screen's bottom edge in the exported " +
+      "app, so the widget's background fills it; a widget that never calls it " +
+      "keeps the inset below its section. Pad the bottom-anchored controls (a composer, a pinned bar, the end of " +
+      "a list) by bottom so they stay clear, with the background behind the " +
+      "padding. The host reports 0 while the keyboard is up (it covers that " +
+      "area), when the app's bottom bar holds the inset, on web (the browser " +
+      "keeps the page inside its own safe area) and for every widget that is " +
+      "not such a surface, so calling it is always safe.",
+    returnShape: {
+      top: "number",
+      right: "number",
+      bottom: "number",
+      left: "number",
+    },
+    requiredContextSlice: ["fitScreenFoot"],
+    scopes: null,
+  },
   {
     name: "useChildRenderer",
     signature: "useChildRenderer()",
@@ -3606,7 +3631,7 @@ const MANIFEST_SCHEMA = {
     type: "boolean",
     required: false,
     description:
-      "Optional (default false). TRUE when the widget is built to own the rest of the screen: it scrolls its own content and keeps its controls in view, like a messenger, a map or a full-height board. Dropping the widget at the top level of a page in the Builder turns that section's \"Fit to screen\" setting on (the maker can switch it off, and it stays off), and the app-builder fits the section it plans the widget into. A fit section runs edge to edge across the content area and takes the rest of the screen; the widget learns it through useFill() and useFitScreen(), and the host gives it a box exactly the height left, which it scrolls inside (a widget without the field grows with its content there, and the page scrolls). Set it only for a widget that honours useFill() and scrolls inside the height it is given; leave it false (or omit) for everything else.",
+      "Optional (default false). TRUE when the widget is built to own the rest of the screen: it scrolls its own content and keeps its controls in view, like a messenger, a map or a full-height board. Dropping the widget at the top level of a page in the Builder turns that section's \"Fit to screen\" setting on (the maker can switch it off, and it stays off), and the app-builder fits the section it plans the widget into. A fit section runs edge to edge across the content area and takes the rest of the screen; the widget learns it through useFill() and useFitScreen(), and the host gives it a box exactly the height left, which it scrolls inside (a widget without the field grows with its content there, and the page scrolls). In the exported app a widget that also calls useFitScreenInsets() has that box run to the screen's bottom edge, under the home indicator: keep the background filling it and pad bottom-anchored controls by useFitScreenInsets().bottom (a widget that never calls it keeps the inset below its section). Set it only for a widget that honours useFill() and scrolls inside the height it is given; leave it false (or omit) for everything else.",
     default: false,
   },
   events: {
@@ -3694,6 +3719,21 @@ const WIDGET_CONTEXT_SHAPE = {
     required: false,
     fields: {},
   },
+  // sc-11615 — optional host hint backing useFitScreenInsets(): the screen's
+  // foot a self-scrolling fit surface may claim.
+  fitScreenFoot: {
+    description:
+      "Optional host layout hint ({ claim } or null). Set only for a " +
+      "self-scrolling Fit to screen surface with nothing below it in the " +
+      "exported app: claim(onInset) runs the surface under the bottom safe " +
+      "area, calls onInset(px) now and on every change, and returns the " +
+      "release. Backs useFitScreenInsets(); null or absent reads as zeros " +
+      "and leaves the inset below the section.",
+    required: false,
+    fields: {
+      claim: "(onInset: (bottom: number) => void) => () => void",
+    },
+  },
   user: {
     description:
       "Signed-in user, host-built context object (camelCase: { id, email, displayName, photoUrl, roles, groupIds }) — NOT a wire payload, so it is the one camelCase island among the hooks. photoUrl is the user's own profile photo as an absolute URL, or null. email is null for an account created without one. Not a data-client.",
@@ -5996,7 +6036,11 @@ const CONTRACT = deepFreeze({
   //    `canSetLocale` and `setLocale(code)`, backed by the optional
   //    `i18n.languages` / `i18n.setLocale` host slice: a widget can switch
   //    the app's language. Hosts without them read [] / false.
-  version: "1.185.0",
+  // 1.186.0: additive (sc-11615) — `useFitScreenInsets()` with its optional
+  //    `fitScreenFoot` host hint: a self-scrolling Fit to screen surface that
+  //    calls it runs under the bottom safe area on native and pads its
+  //    controls by it. Hosts without the hint read zeros.
+  version: "1.186.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/contract.js

@@ -1021,6 +1021,31 @@ const HOOKS = [
     requiredContextSlice: ["fitScreen"],
     scopes: null,
   },
+  {
+    name: "useFitScreenInsets",
+    signature: "useFitScreenInsets()",
+    description:
+      "Returns { top, right, bottom, left } in px: the parts of the device's " +
+      "safe area (the home indicator, a system navigation bar) that this " +
+      "widget's surface runs under. Calling it opts the widget in: only then " +
+      "does a Fit to screen section whose widget scrolls itself (manifest " +
+      "prefersFitToScreen) run to the screen's bottom edge in the exported " +
+      "app, so the widget's background fills it; a widget that never calls it " +
+      "keeps the inset below its section. Pad the bottom-anchored controls (a composer, a pinned bar, the end of " +
+      "a list) by bottom so they stay clear, with the background behind the " +
+      "padding. The host reports 0 while the keyboard is up (it covers that " +
+      "area), when the app's bottom bar holds the inset, on web (the browser " +
+      "keeps the page inside its own safe area) and for every widget that is " +
+      "not such a surface, so calling it is always safe.",
+    returnShape: {
+      top: "number",
+      right: "number",
+      bottom: "number",
+      left: "number",
+    },
+    requiredContextSlice: ["fitScreenFoot"],
+    scopes: null,
+  },
   {
     name: "useChildRenderer",
     signature: "useChildRenderer()",
@@ -3602,7 +3627,7 @@ const MANIFEST_SCHEMA = {
     type: "boolean",
     required: false,
     description:
-      "Optional (default false). TRUE when the widget is built to own the rest of the screen: it scrolls its own content and keeps its controls in view, like a messenger, a map or a full-height board. Dropping the widget at the top level of a page in the Builder turns that section's \"Fit to screen\" setting on (the maker can switch it off, and it stays off), and the app-builder fits the section it plans the widget into. A fit section runs edge to edge across the content area and takes the rest of the screen; the widget learns it through useFill() and useFitScreen(), and the host gives it a box exactly the height left, which it scrolls inside (a widget without the field grows with its content there, and the page scrolls). Set it only for a widget that honours useFill() and scrolls inside the height it is given; leave it false (or omit) for everything else.",
+      "Optional (default false). TRUE when the widget is built to own the rest of the screen: it scrolls its own content and keeps its controls in view, like a messenger, a map or a full-height board. Dropping the widget at the top level of a page in the Builder turns that section's \"Fit to screen\" setting on (the maker can switch it off, and it stays off), and the app-builder fits the section it plans the widget into. A fit section runs edge to edge across the content area and takes the rest of the screen; the widget learns it through useFill() and useFitScreen(), and the host gives it a box exactly the height left, which it scrolls inside (a widget without the field grows with its content there, and the page scrolls). In the exported app a widget that also calls useFitScreenInsets() has that box run to the screen's bottom edge, under the home indicator: keep the background filling it and pad bottom-anchored controls by useFitScreenInsets().bottom (a widget that never calls it keeps the inset below its section). Set it only for a widget that honours useFill() and scrolls inside the height it is given; leave it false (or omit) for everything else.",
     default: false,
   },
   events: {
@@ -3690,6 +3715,21 @@ const WIDGET_CONTEXT_SHAPE = {
     required: false,
     fields: {},
   },
+  // sc-11615 — optional host hint backing useFitScreenInsets(): the screen's
+  // foot a self-scrolling fit surface may claim.
+  fitScreenFoot: {
+    description:
+      "Optional host layout hint ({ claim } or null). Set only for a " +
+      "self-scrolling Fit to screen surface with nothing below it in the " +
+      "exported app: claim(onInset) runs the surface under the bottom safe " +
+      "area, calls onInset(px) now and on every change, and returns the " +
+      "release. Backs useFitScreenInsets(); null or absent reads as zeros " +
+      "and leaves the inset below the section.",
+    required: false,
+    fields: {
+      claim: "(onInset: (bottom: number) => void) => () => void",
+    },
+  },
   user: {
     description:
       "Signed-in user, host-built context object (camelCase: { id, email, displayName, photoUrl, roles, groupIds }) — NOT a wire payload, so it is the one camelCase island among the hooks. photoUrl is the user's own profile photo as an absolute URL, or null. email is null for an account created without one. Not a data-client.",
@@ -5992,7 +6032,11 @@ const CONTRACT = deepFreeze({
   //    `canSetLocale` and `setLocale(code)`, backed by the optional
   //    `i18n.languages` / `i18n.setLocale` host slice: a widget can switch
   //    the app's language. Hosts without them read [] / false.
-  version: "1.185.0",
+  // 1.186.0: additive (sc-11615) — `useFitScreenInsets()` with its optional
+  //    `fitScreenFoot` host hint: a self-scrolling Fit to screen surface that
+  //    calls it runs under the bottom safe area on native and pads its
+  //    controls by it. Hosts without the hint read zeros.
+  version: "1.186.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/hooks.js

@@ -23,6 +23,7 @@ import React, {
   useContext,
   useCallback,
   useEffect,
+  useLayoutEffect,
   useMemo,
   useRef,
   useState,
@@ -501,6 +502,47 @@ export function useFitScreen() {
   return ctx.fitScreen === true;
 }
 
+const NO_FIT_SCREEN_INSETS = Object.freeze({ top: 0, right: 0, bottom: 0, left: 0 });
+
+function insetPx(value) {
+  return typeof value === "number" && Number.isFinite(value) && value > 0 ? value : 0;
+}
+
+/**
+ * Returns `{ top, right, bottom, left }` in px: the parts of the device's safe
+ * area (the home indicator, a system navigation bar) that this widget's
+ * surface runs under. Calling it OPTS the widget in: only then does the host
+ * run a self-scrolling Fit to screen surface (manifest `prefersFitToScreen`)
+ * to the screen's bottom edge in the exported app, so the widget's background
+ * fills it; pad your bottom-anchored controls (a composer, a pinned bar) by
+ * `bottom` to keep them clear. A widget that never calls it keeps the inset
+ * below its section. The host reports 0 while the keyboard is up (it covers
+ * that area), when the app's bottom bar holds the inset, on web (the browser
+ * keeps the page inside its own safe area) and for every widget that is not
+ * such a surface.
+ */
+export function useFitScreenInsets() {
+  const ctx = useWidgetContextOrThrow("useFitScreenInsets");
+  const foot = ctx.fitScreenFoot;
+  const claim = foot && typeof foot.claim === "function" ? foot.claim : null;
+  const [bottom, setBottom] = useState(0);
+  // Before paint, so the surface never shows a frame off the edge.
+  useLayoutEffect(() => {
+    if (!claim) {
+      setBottom(0);
+      return undefined;
+    }
+    const release = claim((value) => setBottom(insetPx(value)));
+    return () => {
+      if (typeof release === "function") release();
+    };
+  }, [claim]);
+  return useMemo(
+    () => (bottom === 0 ? NO_FIT_SCREEN_INSETS : { top: 0, right: 0, bottom, left: 0 }),
+    [bottom],
+  );
+}
+
 /**
  * Returns the host's child-node renderer:
  *   { renderNode(node) }.

package/dist/index.d.ts

@@ -799,6 +799,15 @@ export interface WidgetContext<TProps = unknown> {
    * the rest of the screen). Absent / `false` everywhere else.
    */
   fitScreen?: boolean;
+  /**
+   * sc-11615 — optional host hint backing `useFitScreenInsets()`: set only for
+   * a self-scrolling fit surface with nothing below it. `claim(onInset)` runs
+   * the surface under the bottom safe area, reports the inset in px now and
+   * on every change, and returns the release. Null / absent reads as zeros.
+   */
+  fitScreenFoot?: {
+    claim(onInset: (bottom: number) => void): () => void;
+  } | null;
   /** Active end-user identity from the host-built context (camelCase, not a wire payload). `id` is null when anonymous. */
   user: {
     id: string | null;
@@ -2177,6 +2186,26 @@ export function useFill(): boolean;
  */
 export function useFitScreen(): boolean;
 
+/** Insets in px, one per screen edge. */
+export interface FitScreenInsets {
+  top: number;
+  right: number;
+  bottom: number;
+  left: number;
+}
+
+/**
+ * sc-11615 — the parts of the device's safe area (the home indicator, a
+ * system navigation bar) that this widget's surface runs under. Calling it
+ * opts in: a Fit to screen section whose widget scrolls itself
+ * (`prefersFitToScreen`) then runs to the screen's bottom edge in the exported
+ * app; keep the background filling it and pad bottom-anchored controls (a
+ * composer, a pinned bar) by `bottom`. Never called, the inset stays below.
+ * All zeros while the keyboard is up, when the app's bottom bar holds the
+ * inset, on web, and for every widget that is not such a surface.
+ */
+export function useFitScreenInsets(): FitScreenInsets;
+
 /**
  * The host-provided navigation surface. `goTo(pageId, params?)` navigates
  * to an internal app page; `goBack()` pops the stack. `goToStartPage()`

package/dist/index.js

@@ -81,6 +81,7 @@ export {
   useAnonymousAccount,
   useFill,
   useFitScreen,
+  useFitScreenInsets,
   useNavigation,
   useRouteParams,
   usePageBadge,

package/dist/index.native.js

@@ -81,6 +81,7 @@ export {
   useAnonymousAccount,
   useFill,
   useFitScreen,
+  useFitScreenInsets,
   useNavigation,
   useRouteParams,
   usePageBadge,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.230.0",
+  "version": "0.231.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "homepage": "https://github.com/Colix-AB/AppStudio",
   "type": "module",

package/src/contract.js

@@ -1021,6 +1021,31 @@ const HOOKS = [
     requiredContextSlice: ["fitScreen"],
     scopes: null,
   },
+  {
+    name: "useFitScreenInsets",
+    signature: "useFitScreenInsets()",
+    description:
+      "Returns { top, right, bottom, left } in px: the parts of the device's " +
+      "safe area (the home indicator, a system navigation bar) that this " +
+      "widget's surface runs under. Calling it opts the widget in: only then " +
+      "does a Fit to screen section whose widget scrolls itself (manifest " +
+      "prefersFitToScreen) run to the screen's bottom edge in the exported " +
+      "app, so the widget's background fills it; a widget that never calls it " +
+      "keeps the inset below its section. Pad the bottom-anchored controls (a composer, a pinned bar, the end of " +
+      "a list) by bottom so they stay clear, with the background behind the " +
+      "padding. The host reports 0 while the keyboard is up (it covers that " +
+      "area), when the app's bottom bar holds the inset, on web (the browser " +
+      "keeps the page inside its own safe area) and for every widget that is " +
+      "not such a surface, so calling it is always safe.",
+    returnShape: {
+      top: "number",
+      right: "number",
+      bottom: "number",
+      left: "number",
+    },
+    requiredContextSlice: ["fitScreenFoot"],
+    scopes: null,
+  },
   {
     name: "useChildRenderer",
     signature: "useChildRenderer()",
@@ -3602,7 +3627,7 @@ const MANIFEST_SCHEMA = {
     type: "boolean",
     required: false,
     description:
-      "Optional (default false). TRUE when the widget is built to own the rest of the screen: it scrolls its own content and keeps its controls in view, like a messenger, a map or a full-height board. Dropping the widget at the top level of a page in the Builder turns that section's \"Fit to screen\" setting on (the maker can switch it off, and it stays off), and the app-builder fits the section it plans the widget into. A fit section runs edge to edge across the content area and takes the rest of the screen; the widget learns it through useFill() and useFitScreen(), and the host gives it a box exactly the height left, which it scrolls inside (a widget without the field grows with its content there, and the page scrolls). Set it only for a widget that honours useFill() and scrolls inside the height it is given; leave it false (or omit) for everything else.",
+      "Optional (default false). TRUE when the widget is built to own the rest of the screen: it scrolls its own content and keeps its controls in view, like a messenger, a map or a full-height board. Dropping the widget at the top level of a page in the Builder turns that section's \"Fit to screen\" setting on (the maker can switch it off, and it stays off), and the app-builder fits the section it plans the widget into. A fit section runs edge to edge across the content area and takes the rest of the screen; the widget learns it through useFill() and useFitScreen(), and the host gives it a box exactly the height left, which it scrolls inside (a widget without the field grows with its content there, and the page scrolls). In the exported app a widget that also calls useFitScreenInsets() has that box run to the screen's bottom edge, under the home indicator: keep the background filling it and pad bottom-anchored controls by useFitScreenInsets().bottom (a widget that never calls it keeps the inset below its section). Set it only for a widget that honours useFill() and scrolls inside the height it is given; leave it false (or omit) for everything else.",
     default: false,
   },
   events: {
@@ -3690,6 +3715,21 @@ const WIDGET_CONTEXT_SHAPE = {
     required: false,
     fields: {},
   },
+  // sc-11615 — optional host hint backing useFitScreenInsets(): the screen's
+  // foot a self-scrolling fit surface may claim.
+  fitScreenFoot: {
+    description:
+      "Optional host layout hint ({ claim } or null). Set only for a " +
+      "self-scrolling Fit to screen surface with nothing below it in the " +
+      "exported app: claim(onInset) runs the surface under the bottom safe " +
+      "area, calls onInset(px) now and on every change, and returns the " +
+      "release. Backs useFitScreenInsets(); null or absent reads as zeros " +
+      "and leaves the inset below the section.",
+    required: false,
+    fields: {
+      claim: "(onInset: (bottom: number) => void) => () => void",
+    },
+  },
   user: {
     description:
       "Signed-in user, host-built context object (camelCase: { id, email, displayName, photoUrl, roles, groupIds }) — NOT a wire payload, so it is the one camelCase island among the hooks. photoUrl is the user's own profile photo as an absolute URL, or null. email is null for an account created without one. Not a data-client.",
@@ -5992,7 +6032,11 @@ const CONTRACT = deepFreeze({
   //    `canSetLocale` and `setLocale(code)`, backed by the optional
   //    `i18n.languages` / `i18n.setLocale` host slice: a widget can switch
   //    the app's language. Hosts without them read [] / false.
-  version: "1.185.0",
+  // 1.186.0: additive (sc-11615) — `useFitScreenInsets()` with its optional
+  //    `fitScreenFoot` host hint: a self-scrolling Fit to screen surface that
+  //    calls it runs under the bottom safe area on native and pads its
+  //    controls by it. Hosts without the hint read zeros.
+  version: "1.186.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,