lecodes-sdk 2.5.1 → 2.8.0

package/dist/types/ui/UIModal.d.ts

@@ -1,5 +1,6 @@
 import { type UIWidget, type UIWidgetStyle, WidgetElement } from "./UIWidget";
 import { type BaseStyle, type ChildrenFn, type Color, type DrawableStyle, type UIChildArg, type UINodeChild } from "./UINode";
+import { type Signal } from "../core/signals";
 export type UIModalStyle = UIWidgetStyle;
 /**
  * The modal's hidden pose: `show()` animates from it, `hide()` animates to it. `duration` (ms)
@@ -9,25 +10,45 @@ export type UIModalTransition = DrawableStyle & BaseStyle & {
     overlayColor?: Color | null;
     duration?: number;
 };
+/** What `bindShow()` takes: a function of the data, or a signal the modal also writes (`false` on
+ *  a dismissal, `show()` / `hide()` set it). */
+export type UIModalShow = (() => boolean) | Signal<boolean>;
 /**
  * A dialog: a `UIWidget` with the modal boilerplate built in. Comes with a scrim
- * (`overlayColor: "rgba(0, 0, 0, 0.5)"` unless overridden), animates on `show()`/`hide()` and on
- * a state block flipping its `display` (a 200 ms fade by default — swap the pose via
- * `transition()`; the runtime plays it as tracks that never touch the style), and closes itself
- * on a scrim tap or the Android back button (disable via `dismissible(false)`). Everything else
- * is a plain widget: declare it where it belongs — among its screen's children, hidden until a
- * tap (`display: "none"`), or shown with `show()` from anywhere, which puts a parentless modal in
- * the app layer. A dialog bound to data (its display from a binding) is declared
- * `dismissible(false)` and routes `onOverlayTap` / `onBack` into the data's dismiss, so the data
- * stays what the screen shows.
+ * (`overlayColor: "rgba(0, 0, 0, 0.5)"` unless overridden), is HIDDEN until shown, animates on
+ * every show / hide (a 200 ms fade by default — swap the pose via `transition()`; the runtime
+ * plays it as tracks that never touch the style).
+ *
+ * One state, shown or not, driven one of two ways:
+ * - `show()` / `hide()` from code — an action sheet opened by a button;
+ * - `bindShow(…)`: a function of the data (`bindShow(() => data.value.confirm)` — the data is the
+ *   truth, `show()` / `hide()` are refused) or a `Signal<boolean>` the modal reads AND writes.
+ *
+ * A dismissal — the scrim tap, the back press, a sheet dragged below its lowest detent — is ONE
+ * request, `onDismiss`. By default it hides an unbound modal and writes `false` into a bound
+ * signal; a bound function has nowhere to write, so a modal bound to one without `onDismiss`
+ * cannot be dismissed (a forced choice — the same as `dismissible(false)`). `display` is not a
+ * modal's switch: a `.style({ display })` on it throws (a bound display died on the first
+ * dismissal, which wrote a static `display: "none"` over the binding — the dialog never opened
+ * again).
  */
 export interface UIModal extends UIWidget {
-    /** Show and play the entrance transition. No-op while already open. */
+    /**
+     * Bind the shown state. A function: the modal follows the data, and `show()` / `hide()` are
+     * errors — flip the data (`onDismiss` is where a dismissal goes). A signal: read and written —
+     * a dismissal sets it `false`, `show()` / `hide()` set it.
+     *
+     * ```ts
+     * UIModal(...).bindShow(() => data.value.confirm).onDismiss(on.cancel)   // the data is the truth
+     * UIModal(...).bindShow(confirmOpen)                                       // a Signal<boolean>
+     * ```
+     */
+    bindShow(value: UIModalShow): this;
+    /** Show and play the entrance transition. No-op while already shown. Bound to a signal: writes
+     *  `true` into it; bound to a function: an error (flip the data). */
     show(): void;
-    /** Play the exit transition, then hide. No-op while closed or already closing. */
+    /** Play the exit transition, then hide. No-op while hidden. Bound: as `show()`. */
     hide(): void;
-    /** True from `show()` until `hide()` starts (already false during the exit animation). */
-    readonly isOpen: boolean;
     /**
      * Replace the show/hide animation. `hidden` is the off-screen pose — `show()` animates from
      * it, `hide()` animates to it. Default `{ opacity: 0, duration: 200 }` (a fade); the pose
@@ -39,13 +60,17 @@ export interface UIModal extends UIWidget {
      * ```
      */
     transition(hidden: UIModalTransition): this;
-    /** Called when the modal opens — `show()`, or a state block flipping its display. */
+    /** The user asked to close: a scrim tap, the back press, a sheet dragged below its lowest
+     *  detent. Replaces the default (hide, or `false` into the signal): the callback decides —
+     *  usually the action that flips the data the modal is bound to. */
+    onDismiss(callback: () => void): this;
+    /** Called when the modal is shown — whoever showed it. */
     onOpen(callback: () => void): this;
-    /** Called when the modal starts closing — scrim tap, back button, a `hide()` call, or a state
-     *  block flipping its display. */
+    /** Called when the modal starts hiding — whoever hid it. */
     onClose(callback: () => void): this;
-    /** `dismissible(false)` keeps scrim taps and the back button from closing the modal
-     *  (forced-choice dialogs, a dialog whose display is bound to data). Default `true`. */
+    /** `dismissible(false)`: the dismissal gestures are off — the scrim tap does nothing, the back
+     *  press is swallowed, a sheet resists below its lowest detent (a forced choice, the persistent
+     *  map sheet). Default `true`. */
     dismissible(enabled: boolean): this;
 }
 export declare class ModalElement extends WidgetElement {
@@ -53,20 +78,23 @@ export declare class ModalElement extends WidgetElement {
     _transition: UIModalTransition;
     readonly _openListeners: (() => void)[];
     readonly _closeListeners: (() => void)[];
+    readonly _dismissListeners: (() => void)[];
     private _poseObj?;
     private _poseKey;
     constructor(style: UIModalStyle, children: UINodeChild[] | ChildrenFn);
     private _pose;
     transition(hidden: UIModalTransition): this;
+    bindShow(value: UIModalShow): this;
     show(): void;
     hide(): void;
-    get isOpen(): boolean;
+    _setOpen(open: boolean): void;
+    onDismiss(callback: () => void): this;
     onOpen(callback: () => void): this;
     onClose(callback: () => void): this;
     dismissible(enabled: boolean): this;
 }
-/** Create a modal dialog (see {@link UIModal}): declare it among its screen's children with
- *  `display: "none"` and `show()` it from a tap, or `show()` a parentless one from anywhere.
- *  Same argument forms as `UIColumn`. */
+/** Create a modal dialog (see {@link UIModal}): give it to its screen (`.widgets(dialog)`) and
+ *  `show()` it from a tap, bind it to the data with `bindShow(() => …)`, or `show()` a parentless
+ *  one from anywhere. Same argument forms as `UIColumn`. */
 export declare function UIModal(...children: UIChildArg[]): UIModal;
 export declare function UIModal(children: UINodeChild[] | ChildrenFn): UIModal;

package/dist/types/version.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "2.5.1";
+export declare const SDK_VERSION = "2.8.0";
 /** The major of a semver string, or null when it is not one. */
 export declare const sdkMajor: (version: string | null | undefined) => number | null;
 /** The `// sdk: <version>` line of a compiled bundle's header (sdk/src/compile/header.ts), read from