cx 26.4.0 → 26.4.1

package/src/ui/DetachedScope.tsx

@@ -1,159 +1,159 @@
-/** @jsxImportSource react */
-
-import { PureContainer } from "./PureContainer";
-import { SubscribableView, SubscribableViewConfig } from "../data/SubscribableView";
-import { getSelector } from "../data/getSelector";
-import { Cx } from "./Cx";
-import { VDOM } from "./Widget";
-import { IsolatedScope, IsolatedScopeConfig } from "./IsolatedScope";
-import { Instance } from "./Instance";
-import { StructuredProp } from "./Prop";
-
-interface ContainmentStoreConfig extends SubscribableViewConfig {
-   selector: any;
-}
-
-class ContainmentStore extends SubscribableView<any> {
-   declare selector: any;
-   declare cache: {
-      version: number;
-      data?: any;
-      result?: any;
-      itemIndex?: number;
-      key?: string;
-      parentStoreData?: any;
-      containedData?: any;
-   };
-
-   constructor(config: ContainmentStoreConfig) {
-      super(config);
-      this.selector = config.selector;
-   }
-
-   getData() {
-      return this.store!.getData();
-   }
-
-   setItem(path: string, value: any) {
-      return this.wrapper(() => {
-         this.store!.setItem(path, value);
-      });
-   }
-
-   deleteItem(path: string) {
-      return this.wrapper(() => {
-         this.store!.deleteItem(path);
-      });
-   }
-
-   wrapper(callback: () => void) {
-      if (this.store!.silently(callback)) {
-         let data = this.getData();
-         let containedData = this.selector(data);
-         if (containedData === this.cache.containedData) {
-            this.store!.notify();
-         } else {
-            this.cache.containedData = containedData;
-            this.notify(undefined!);
-         }
-         return true;
-      }
-      return false;
-   }
-}
-
-export interface DetachedScopeInstance extends Instance {
-   subStore: ContainmentStore;
-}
-
-export interface DetachedScopeConfig extends IsolatedScopeConfig {
-   /**
-    * A single binding path or a list of paths to be monitored for changes.
-    * Use `exclusive` as a shorthand for defining the `exclusiveData` object.
-    */
-   exclusive?: string | string[];
-
-   /**
-    * Exclusive data selector. If only exclusive data change, the scope will be re-rendered
-    * without recalculating other elements on the page.
-    * Use in case if the scope uses both exclusive and shared data.
-    */
-   exclusiveData?: StructuredProp;
-
-   /** Name of the scope used for debugging/reporting purposes. */
-   name?: string;
-
-   /** Options passed to the Cx component. */
-   options?: any;
-
-   /** Error handler for the detached scope. */
-   onError?: (error: Error, instance: Instance, info: any) => void;
-}
-
-export class DetachedScope extends IsolatedScope<DetachedScopeConfig, DetachedScopeInstance> {
-   declare exclusive?: string | string[];
-   declare exclusiveData?: any;
-   declare container?: any;
-   declare name?: string;
-   declare options?: any;
-   declare onError?: any;
-
-   declareData(...args: any[]) {
-      return super.declareData(...args, {
-         exclusiveData: { structured: true },
-      });
-   }
-
-   init() {
-      if (typeof this.exclusive === "string") this.exclusiveData = { bind: this.exclusive };
-      if (Array.isArray(this.exclusive)) {
-         this.exclusiveData = {};
-         this.exclusive.forEach((x, i) => {
-            this.exclusiveData[String(i)] = { bind: x };
-         });
-      }
-
-      this.container = PureContainer.create({
-         type: PureContainer,
-         items: this.children || this.items,
-      });
-
-      delete this.children;
-      this.items = [];
-
-      if (this.name)
-         this.options = {
-            ...this.options,
-            name: this.name,
-         };
-
-      super.init();
-   }
-
-   initInstance(context: any, instance: DetachedScopeInstance) {
-      const config: ContainmentStoreConfig = {
-         store: instance.parentStore,
-         selector: getSelector(this.exclusiveData || this.data),
-      };
-      instance.subStore = new ContainmentStore(config);
-   }
-
-   applyParentStore(instance: any) {
-      instance.store = instance.parentStore;
-      instance.subStore.setStore(instance.parentStore);
-   }
-
-   render(context: any, instance: any, key: string) {
-      return (
-         <Cx
-            key={key}
-            widget={this.container}
-            store={instance.subStore}
-            parentInstance={instance}
-            subscribe
-            options={this.options}
-            onError={this.onError}
-         />
-      );
-   }
-}
+/** @jsxImportSource react */
+
+import { PureContainer } from "./PureContainer";
+import { SubscribableView, SubscribableViewConfig } from "../data/SubscribableView";
+import { getSelector } from "../data/getSelector";
+import { Cx } from "./Cx";
+import { VDOM } from "./Widget";
+import { IsolatedScope, IsolatedScopeConfig } from "./IsolatedScope";
+import { Instance } from "./Instance";
+import { StructuredProp } from "./Prop";
+
+interface ContainmentStoreConfig extends SubscribableViewConfig {
+   selector: any;
+}
+
+class ContainmentStore extends SubscribableView<any> {
+   declare selector: any;
+   declare cache: {
+      version: number;
+      data?: any;
+      result?: any;
+      itemIndex?: number;
+      key?: string;
+      parentStoreData?: any;
+      containedData?: any;
+   };
+
+   constructor(config: ContainmentStoreConfig) {
+      super(config);
+      this.selector = config.selector;
+   }
+
+   getData() {
+      return this.store!.getData();
+   }
+
+   setItem(path: string, value: any) {
+      return this.wrapper(() => {
+         this.store!.setItem(path, value);
+      });
+   }
+
+   deleteItem(path: string) {
+      return this.wrapper(() => {
+         this.store!.deleteItem(path);
+      });
+   }
+
+   wrapper(callback: () => void) {
+      if (this.store!.silently(callback)) {
+         let data = this.getData();
+         let containedData = this.selector(data);
+         if (containedData === this.cache.containedData) {
+            this.store!.notify();
+         } else {
+            this.cache.containedData = containedData;
+            this.notify(undefined!);
+         }
+         return true;
+      }
+      return false;
+   }
+}
+
+export interface DetachedScopeInstance extends Instance {
+   subStore: ContainmentStore;
+}
+
+export interface DetachedScopeConfig extends IsolatedScopeConfig {
+   /**
+    * A single binding path or a list of paths to be monitored for changes.
+    * Use `exclusive` as a shorthand for defining the `exclusiveData` object.
+    */
+   exclusive?: string | string[];
+
+   /**
+    * Exclusive data selector. If only exclusive data change, the scope will be re-rendered
+    * without recalculating other elements on the page.
+    * Use in case if the scope uses both exclusive and shared data.
+    */
+   exclusiveData?: StructuredProp;
+
+   /** Name of the scope used for debugging/reporting purposes. */
+   name?: string;
+
+   /** Options passed to the Cx component. */
+   options?: any;
+
+   /** Error handler for the detached scope. */
+   onError?: (error: Error, instance: Instance, info: any) => void;
+}
+
+export class DetachedScope extends IsolatedScope<DetachedScopeConfig, DetachedScopeInstance> {
+   declare exclusive?: string | string[];
+   declare exclusiveData?: any;
+   declare container?: any;
+   declare name?: string;
+   declare options?: any;
+   declare onError?: any;
+
+   declareData(...args: any[]) {
+      return super.declareData(...args, {
+         exclusiveData: { structured: true },
+      });
+   }
+
+   init() {
+      if (typeof this.exclusive === "string") this.exclusiveData = { bind: this.exclusive };
+      if (Array.isArray(this.exclusive)) {
+         this.exclusiveData = {};
+         this.exclusive.forEach((x, i) => {
+            this.exclusiveData[String(i)] = { bind: x };
+         });
+      }
+
+      this.container = PureContainer.create({
+         type: PureContainer,
+         items: this.children || this.items,
+      });
+
+      delete this.children;
+      this.items = [];
+
+      if (this.name)
+         this.options = {
+            ...this.options,
+            name: this.name,
+         };
+
+      super.init();
+   }
+
+   initInstance(context: any, instance: DetachedScopeInstance) {
+      const config: ContainmentStoreConfig = {
+         store: instance.parentStore,
+         selector: getSelector(this.exclusiveData || this.data),
+      };
+      instance.subStore = new ContainmentStore(config);
+   }
+
+   applyParentStore(instance: any) {
+      instance.store = instance.parentStore;
+      instance.subStore.setStore(instance.parentStore);
+   }
+
+   render(context: any, instance: any, key: string) {
+      return (
+         <Cx
+            key={key}
+            widget={this.container}
+            store={instance.subStore}
+            parentInstance={instance}
+            subscribe
+            options={this.options}
+            onError={this.onError}
+         />
+      );
+   }
+}

package/src/ui/FocusManager.ts

@@ -1,171 +1,171 @@
-import { isSelfOrDescendant, findFirst, findFirstChild, isFocusable, closestParent } from "../util/DOM";
-import { batchUpdates } from "./batchUpdates";
-import { SubscriberList } from "../util/SubscriberList";
-import { isTouchEvent } from "../util/isTouchEvent";
-import { getActiveElement } from "../util/getActiveElement";
-
-/*
- *  Purpose of FocusManager is to provide focusout notifications.
- *  IE and Firefox do not provide relatedTarget info in blur events which makes it impossible
- *  to determine if focus went outside or stayed inside the component.
- */
-
-let subscribers = new SubscriberList(),
-   timerInterval = 300,
-   timerId: any = null;
-
-let lastActiveElement: any = null;
-let pending = false;
-
-export class FocusManager {
-   static subscribe(callback: (el: any) => void) {
-      let unsubscribe = subscribers.subscribe(callback);
-      checkTimer();
-      return unsubscribe;
-   }
-
-   static onFocusOut(el: any, callback: (el: any) => void) {
-      let active = isSelfOrDescendant(el, getActiveElement());
-      return this.subscribe((focusedEl: any) => {
-         if (!active) active = isSelfOrDescendant(el, getActiveElement());
-         else if (!isSelfOrDescendant(el, focusedEl)) {
-            active = false;
-            callback(focusedEl);
-         }
-      });
-   }
-
-   static oneFocusOut(el: any, callback: (el: any) => void) {
-      this.nudge();
-      let off = this.subscribe((focusedEl: any) => {
-         if (!isSelfOrDescendant(el, focusedEl)) {
-            callback(focusedEl);
-            off();
-         }
-      });
-      return off;
-   }
-
-   static nudge() {
-      if (typeof document !== "undefined" && getActiveElement() !== lastActiveElement) {
-         if (!pending) {
-            pending = true;
-            setTimeout(function () {
-               pending = false;
-               if (getActiveElement() !== lastActiveElement) {
-                  lastActiveElement = getActiveElement();
-                  batchUpdates(() => {
-                     subscribers.notify(lastActiveElement);
-                  });
-                  checkTimer();
-               }
-            }, 0);
-         }
-      }
-   }
-
-   static focus(el: HTMLElement) {
-      el.focus();
-      this.nudge();
-   }
-
-   static focusFirst(el: HTMLElement) {
-      let focusable = findFirst(el, isFocusable);
-      if (focusable) this.focus(focusable as HTMLElement);
-      return focusable;
-   }
-
-   static focusFirstChild(el: HTMLElement) {
-      let focusable = findFirstChild(el, isFocusable);
-      if (focusable) this.focus(focusable as HTMLElement);
-      return focusable;
-   }
-
-   static focusNext(el: HTMLElement) {
-      let next: Node | null = el,
-         skip = true;
-      do {
-         if (!skip) {
-            let focusable = this.focusFirst(next as HTMLElement);
-            if (focusable) return focusable;
-         }
-
-         if (next.nextSibling) {
-            next = next.nextSibling;
-            skip = false;
-         } else {
-            next = next.parentNode;
-            skip = true;
-         }
-      } while (next);
-   }
-
-   static setInterval(interval: number) {
-      timerInterval = interval;
-      checkTimer();
-   }
-}
-
-export function oneFocusOut(component: any, el: any, callback: (focus: any) => void) {
-   if (!component.oneFocusOut)
-      component.oneFocusOut = FocusManager.oneFocusOut(el, (focus: any) => {
-         delete component.oneFocusOut;
-         callback(focus);
-      });
-}
-
-export function offFocusOut(component: any) {
-   if (component.oneFocusOut) {
-      component.oneFocusOut();
-      delete component.oneFocusOut;
-   }
-}
-
-export function preventFocus(e: React.MouseEvent) {
-   //Focus can be prevented only on mousedown event. On touchstart this will not work
-   //preventDefault cannot be used as it prevents scrolling
-   if (e.type !== "mousedown") return;
-
-   e.preventDefault();
-
-   unfocusElement(e.currentTarget, false);
-}
-
-function checkTimer() {
-   let shouldRun = !subscribers.isEmpty();
-
-   if (shouldRun && !timerId)
-      timerId = setInterval(() => {
-         FocusManager.nudge();
-      }, timerInterval);
-
-   if (!shouldRun && timerId) {
-      clearInterval(timerId);
-      timerId = null;
-   }
-}
-
-export function preventFocusOnTouch(e: any, force = false) {
-   if (force || isTouchEvent()) preventFocus(e);
-}
-
-export function unfocusElement(target: Element | null = null, unfocusParentOverlay = true) {
-   const activeElement = getActiveElement();
-   if (!target) target = activeElement;
-
-   if (unfocusParentOverlay) {
-      let focusableOverlayContainer = closestParent(target, (el: any) => el.dataset?.focusableOverlayContainer);
-      if (focusableOverlayContainer) target = focusableOverlayContainer;
-   }
-
-   //find the closest focusable parent of the target element and focus it instead
-   let focusableParent = closestParent(
-      target,
-      (el: any) => isFocusable(el) && (!unfocusParentOverlay || !!el.dataset?.focusableOverlayContainer),
-   ) as HTMLElement | null;
-
-   if (focusableParent && focusableParent !== document.body) focusableParent.focus({ preventScroll: true });
-   else (activeElement as HTMLElement).blur();
-
-   FocusManager.nudge();
-}
+import { isSelfOrDescendant, findFirst, findFirstChild, isFocusable, closestParent } from "../util/DOM";
+import { batchUpdates } from "./batchUpdates";
+import { SubscriberList } from "../util/SubscriberList";
+import { isTouchEvent } from "../util/isTouchEvent";
+import { getActiveElement } from "../util/getActiveElement";
+
+/*
+ *  Purpose of FocusManager is to provide focusout notifications.
+ *  IE and Firefox do not provide relatedTarget info in blur events which makes it impossible
+ *  to determine if focus went outside or stayed inside the component.
+ */
+
+let subscribers = new SubscriberList(),
+   timerInterval = 300,
+   timerId: any = null;
+
+let lastActiveElement: any = null;
+let pending = false;
+
+export class FocusManager {
+   static subscribe(callback: (el: any) => void) {
+      let unsubscribe = subscribers.subscribe(callback);
+      checkTimer();
+      return unsubscribe;
+   }
+
+   static onFocusOut(el: any, callback: (el: any) => void) {
+      let active = isSelfOrDescendant(el, getActiveElement());
+      return this.subscribe((focusedEl: any) => {
+         if (!active) active = isSelfOrDescendant(el, getActiveElement());
+         else if (!isSelfOrDescendant(el, focusedEl)) {
+            active = false;
+            callback(focusedEl);
+         }
+      });
+   }
+
+   static oneFocusOut(el: any, callback: (el: any) => void) {
+      this.nudge();
+      let off = this.subscribe((focusedEl: any) => {
+         if (!isSelfOrDescendant(el, focusedEl)) {
+            callback(focusedEl);
+            off();
+         }
+      });
+      return off;
+   }
+
+   static nudge() {
+      if (typeof document !== "undefined" && getActiveElement() !== lastActiveElement) {
+         if (!pending) {
+            pending = true;
+            setTimeout(function () {
+               pending = false;
+               if (getActiveElement() !== lastActiveElement) {
+                  lastActiveElement = getActiveElement();
+                  batchUpdates(() => {
+                     subscribers.notify(lastActiveElement);
+                  });
+                  checkTimer();
+               }
+            }, 0);
+         }
+      }
+   }
+
+   static focus(el: HTMLElement) {
+      el.focus();
+      this.nudge();
+   }
+
+   static focusFirst(el: HTMLElement) {
+      let focusable = findFirst(el, isFocusable);
+      if (focusable) this.focus(focusable as HTMLElement);
+      return focusable;
+   }
+
+   static focusFirstChild(el: HTMLElement) {
+      let focusable = findFirstChild(el, isFocusable);
+      if (focusable) this.focus(focusable as HTMLElement);
+      return focusable;
+   }
+
+   static focusNext(el: HTMLElement) {
+      let next: Node | null = el,
+         skip = true;
+      do {
+         if (!skip) {
+            let focusable = this.focusFirst(next as HTMLElement);
+            if (focusable) return focusable;
+         }
+
+         if (next.nextSibling) {
+            next = next.nextSibling;
+            skip = false;
+         } else {
+            next = next.parentNode;
+            skip = true;
+         }
+      } while (next);
+   }
+
+   static setInterval(interval: number) {
+      timerInterval = interval;
+      checkTimer();
+   }
+}
+
+export function oneFocusOut(component: any, el: any, callback: (focus: any) => void) {
+   if (!component.oneFocusOut)
+      component.oneFocusOut = FocusManager.oneFocusOut(el, (focus: any) => {
+         delete component.oneFocusOut;
+         callback(focus);
+      });
+}
+
+export function offFocusOut(component: any) {
+   if (component.oneFocusOut) {
+      component.oneFocusOut();
+      delete component.oneFocusOut;
+   }
+}
+
+export function preventFocus(e: React.MouseEvent) {
+   //Focus can be prevented only on mousedown event. On touchstart this will not work
+   //preventDefault cannot be used as it prevents scrolling
+   if (e.type !== "mousedown") return;
+
+   e.preventDefault();
+
+   unfocusElement(e.currentTarget, false);
+}
+
+function checkTimer() {
+   let shouldRun = !subscribers.isEmpty();
+
+   if (shouldRun && !timerId)
+      timerId = setInterval(() => {
+         FocusManager.nudge();
+      }, timerInterval);
+
+   if (!shouldRun && timerId) {
+      clearInterval(timerId);
+      timerId = null;
+   }
+}
+
+export function preventFocusOnTouch(e: any, force = false) {
+   if (force || isTouchEvent()) preventFocus(e);
+}
+
+export function unfocusElement(target: Element | null = null, unfocusParentOverlay = true) {
+   const activeElement = getActiveElement();
+   if (!target) target = activeElement;
+
+   if (unfocusParentOverlay) {
+      let focusableOverlayContainer = closestParent(target, (el: any) => el.dataset?.focusableOverlayContainer);
+      if (focusableOverlayContainer) target = focusableOverlayContainer;
+   }
+
+   //find the closest focusable parent of the target element and focus it instead
+   let focusableParent = closestParent(
+      target,
+      (el: any) => isFocusable(el) && (!unfocusParentOverlay || !!el.dataset?.focusableOverlayContainer),
+   ) as HTMLElement | null;
+
+   if (focusableParent && focusableParent !== document.body) focusableParent.focus({ preventScroll: true });
+   else (activeElement as HTMLElement).blur();
+
+   FocusManager.nudge();
+}