solid-ctrl-flow 7.0.0 → 7.0.1

package/dist/index.d.ts

@@ -230,6 +230,21 @@ declare class State {
 /** Type of an element wrapping call-back which accepts an additional parameter */
 declare type Template<T> = (c: Accessor<JSX.Element>, x: T) => JSX.Element;
 
+/** Object that reactively tells whether a CSS transition is currently in progress */
+export declare class TransitionMonitor {
+    #private;
+    /** Whether a transition is currently in progress */
+    get pending(): boolean;
+    /**
+     * Starts waiting for the transition to end.
+     * This function should be called immediately before the transition is triggered.
+     * If a transition is already in progress, this function does nothing, allowing the object to keep monitoring the previous transition, but the returned {@link Promise} will not wait for the latter to complete
+     * @param ctrl The element on which the transition will occur
+     * @returns A {@link Promise} that resolves to whether monitoring completed successfully or was cancelled because a transition was already in progress
+     */
+    start(ctrl: HTMLElement): Promise<boolean>;
+}
+
 /** Parameters to pass to an unkeyed {@link Enfold} */
 declare type Unkeyed<T> = Standard<T> & {
     keyed?: false;

package/dist/index.mjs

@@ -285,6 +285,32 @@ class MemoPropsHandler {
     return runWithOwner(this.owner, () => createMemo(() => t[k], void 0, opts));
   }
 }
+class TransitionMonitor {
+  #signal = createSignal(false);
+  /** Whether a transition is currently in progress */
+  get pending() {
+    return this.#signal[0]();
+  }
+  /**
+   * Starts waiting for the transition to end.
+   * This function should be called immediately before the transition is triggered.
+   * If a transition is already in progress, this function does nothing, allowing the object to keep monitoring the previous transition, but the returned {@link Promise} will not wait for the latter to complete
+   * @param ctrl The element on which the transition will occur
+   * @returns A {@link Promise} that resolves to whether monitoring completed successfully or was cancelled because a transition was already in progress
+   */
+  async start(ctrl) {
+    const [g, s] = this.#signal;
+    if (g())
+      return false;
+    s(true);
+    try {
+      await new Promise((t) => ctrl.addEventListener("transitionend", t, { once: true }));
+    } finally {
+      s(false);
+    }
+    return true;
+  }
+}
 function SameContext(props) {
   return createMemo(() => {
     getOwner().context = props.owner.context;
@@ -304,6 +330,7 @@ export {
   OrderedLinkedList,
   SameContext,
   Spread,
+  TransitionMonitor,
   disposeWithOwner,
   memoProps,
   runWithContext,

package/dist/index.umd.js

@@ -287,6 +287,32 @@
       return solidJs.runWithOwner(this.owner, () => solidJs.createMemo(() => t[k], void 0, opts));
     }
   }
+  class TransitionMonitor {
+    #signal = solidJs.createSignal(false);
+    /** Whether a transition is currently in progress */
+    get pending() {
+      return this.#signal[0]();
+    }
+    /**
+     * Starts waiting for the transition to end.
+     * This function should be called immediately before the transition is triggered.
+     * If a transition is already in progress, this function does nothing, allowing the object to keep monitoring the previous transition, but the returned {@link Promise} will not wait for the latter to complete
+     * @param ctrl The element on which the transition will occur
+     * @returns A {@link Promise} that resolves to whether monitoring completed successfully or was cancelled because a transition was already in progress
+     */
+    async start(ctrl) {
+      const [g, s] = this.#signal;
+      if (g())
+        return false;
+      s(true);
+      try {
+        await new Promise((t) => ctrl.addEventListener("transitionend", t, { once: true }));
+      } finally {
+        s(false);
+      }
+      return true;
+    }
+  }
   function SameContext(props) {
     return solidJs.createMemo(() => {
       solidJs.getOwner().context = props.owner.context;
@@ -305,6 +331,7 @@
   exports2.OrderedLinkedList = OrderedLinkedList;
   exports2.SameContext = SameContext;
   exports2.Spread = Spread;
+  exports2.TransitionMonitor = TransitionMonitor;
   exports2.disposeWithOwner = disposeWithOwner;
   exports2.memoProps = memoProps;
   exports2.runWithContext = runWithContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-ctrl-flow",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "Control flow components for solid-js",
   "author": "AFatNiBBa",
   "license": "ISC",