zcw-shared 1.24.0 → 1.25.0

package/dist/vue-hooks/dom/useAutoUpdate.d.ts

@@ -0,0 +1,19 @@
+import type { UnwrapRef } from '../../../references/vue.d';
+import type { VueCompositionAPI } from '../../../types/vue.d';
+import type { CreateThrottledEventListenerDeps } from '../../functions/dom/createThrottledEventListener';
+export interface StateData {
+    visible: boolean;
+}
+export type State = UnwrapRef<StateData>;
+export interface UseAutoUpdateDeps extends CreateThrottledEventListenerDeps {
+    watch: VueCompositionAPI['watch'];
+}
+export interface UseAutoUpdateOptions {
+    state: State;
+    update: () => void;
+    throttleMs?: number;
+}
+export interface UseAutoUpdateReturn {
+    destroy: () => void;
+}
+export declare function useAutoUpdate(options: UseAutoUpdateOptions, deps: UseAutoUpdateDeps): UseAutoUpdateReturn;

package/dist/vue-hooks/dom/useAutoUpdate.js

@@ -0,0 +1,41 @@
+import { createThrottledEventListener } from '../../functions/dom/createThrottledEventListener';
+export function useAutoUpdate(options, deps) {
+    const { state, update, throttleMs = 0 } = options;
+    let resizeCleanup = null;
+    let scrollCleanup = null;
+    const stopAutoUpdateWatch = deps.watch(() => state.visible, (visible) => {
+        if (visible) {
+            if (!resizeCleanup) {
+                resizeCleanup = createThrottledEventListener('resize', update, throttleMs, deps);
+            }
+            if (!scrollCleanup) {
+                scrollCleanup = createThrottledEventListener('scroll', update, throttleMs, deps);
+            }
+        }
+        else {
+            if (resizeCleanup) {
+                resizeCleanup();
+                resizeCleanup = null;
+            }
+            if (scrollCleanup) {
+                scrollCleanup();
+                scrollCleanup = null;
+            }
+        }
+    }, { immediate: true });
+    const destroy = () => {
+        try {
+            stopAutoUpdateWatch();
+            resizeCleanup?.();
+            scrollCleanup?.();
+        }
+        finally {
+            resizeCleanup = null;
+            scrollCleanup = null;
+        }
+    };
+    return {
+        destroy,
+    };
+}
+//# sourceMappingURL=useAutoUpdate.js.map

package/dist/vue-hooks/dom/useAutoUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAutoUpdate.js","sourceRoot":"","sources":["../../../src/vue-hooks/dom/useAutoUpdate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,4BAA4B,EAAE,MAAM,kDAAkD,CAAA;AA8E/F,MAAM,UAAU,aAAa,CAC3B,OAA6B,EAC7B,IAAuB;IAEvB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,GAAG,OAAO,CAAA;IAEjD,IAAI,aAAa,GAAwB,IAAI,CAAA;IAC7C,IAAI,aAAa,GAAwB,IAAI,CAAA;IAG7C,MAAM,mBAAmB,GAAoB,IAAI,CAAC,KAAM,CACtD,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EACnB,CAAC,OAAO,EAAE,EAAE;QACV,IAAI,OAAO,EAAE,CAAC;YAEZ,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,aAAa,GAAG,4BAA4B,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;YAClF,CAAC;YACD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,aAAa,GAAG,4BAA4B,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;YAClF,CAAC;QACH,CAAC;aAAM,CAAC;YAEN,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,EAAE,CAAA;gBACf,aAAa,GAAG,IAAI,CAAA;YACtB,CAAC;YACD,IAAI,aAAa,EAAE,CAAC;gBAClB,aAAa,EAAE,CAAA;gBACf,aAAa,GAAG,IAAI,CAAA;YACtB,CAAC;QACH,CAAC;IACH,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAA;IAED,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,CAAC;YACH,mBAAmB,EAAE,CAAA;YACrB,aAAa,EAAE,EAAE,CAAA;YACjB,aAAa,EAAE,EAAE,CAAA;QACnB,CAAC;gBAAS,CAAC;YACT,aAAa,GAAG,IAAI,CAAA;YACpB,aAAa,GAAG,IAAI,CAAA;QACtB,CAAC;IACH,CAAC,CAAA;IAED,OAAO;QACL,OAAO;KACR,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zcw-shared",
-  "version": "1.24.0",
+  "version": "1.25.0",
   "files": [
     "references",
     "dist",
@@ -265,6 +265,7 @@
     "./vue-hooks/browser/useScreenWakeLock": "./dist/vue-hooks/browser/useScreenWakeLock.js",
     "./vue-hooks/browser/useShare": "./dist/vue-hooks/browser/useShare.js",
     "./vue-hooks/browser/useVibration": "./dist/vue-hooks/browser/useVibration.js",
+    "./vue-hooks/dom/useAutoUpdate": "./dist/vue-hooks/dom/useAutoUpdate.js",
     "./vue-hooks/dom/useClickOutside": "./dist/vue-hooks/dom/useClickOutside.js",
     "./vue-hooks/dom/useDraggable": "./dist/vue-hooks/dom/useDraggable.js",
     "./vue-hooks/dom/useEventListener": "./dist/vue-hooks/dom/useEventListener.js",

package/types/vue.d.ts

@@ -1,5 +1,5 @@
 import type { ColorReference } from './design-system.d'
-import type { Ref, InjectionKey } from '../references/vue.d'
+import type { Ref, InjectionKey, WatchStopHandle } from '../references/vue.d'
 
 /**
  * Vue Composition API 通用接口
@@ -19,7 +19,7 @@ export interface VueCompositionAPI {
   /** 注入依赖 */
   inject?: <T>(key: InjectionKey<T> | string, defaultValue?: T) => T | undefined
   /** 监听响应式数据变化 */
-  watch?: (source: any, callback: () => void, options?: { deep?: boolean; flush?: string }) => void
+  watch?: <T>(source: (() => T) | Ref<T>, callback: (newValue: T, oldValue: T) => void, options?: { deep?: boolean; flush?: string; immediate?: boolean }) => WatchStopHandle
 }
 
 /**