@v-c/util 1.0.7 → 1.0.9

package/dist/Dom/focus.cjs

@@ -1,5 +1,6 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_isVisible = require("./isVisible.cjs");
+let vue = require("vue");
 function focusable(node, includePositive = false) {
 	if (require_isVisible.default(node)) {
 		const nodeName = node.nodeName.toLowerCase();
@@ -26,27 +27,6 @@ function getFocusNodeList(node, includePositive = false) {
 	if (focusable(node, includePositive)) res.unshift(node);
 	return res;
 }
-var lastFocusElement = null;
-function saveLastFocusNode() {
-	lastFocusElement = document.activeElement;
-}
-function clearLastFocusNode() {
-	lastFocusElement = null;
-}
-function backLastFocusNode() {
-	if (lastFocusElement) try {
-		lastFocusElement.focus();
-	} catch (_e) {}
-}
-function limitTabRange(node, e) {
-	if (e.keyCode === 9) {
-		const tabNodeList = getFocusNodeList(node);
-		if (tabNodeList[e.shiftKey ? 0 : tabNodeList.length - 1] === document.activeElement || node === document.activeElement) {
-			tabNodeList[e.shiftKey ? tabNodeList.length - 1 : 0].focus();
-			e.preventDefault();
-		}
-	}
-}
 function triggerFocus(element, option) {
 	if (!element) return;
 	element.focus(option);
@@ -64,9 +44,58 @@ function triggerFocus(element, option) {
 		}
 	}
 }
-exports.backLastFocusNode = backLastFocusNode;
-exports.clearLastFocusNode = clearLastFocusNode;
+var lastFocusElement = null;
+var focusElements = [];
+function getLastElement() {
+	return focusElements[focusElements.length - 1];
+}
+function hasFocus(element) {
+	const { activeElement } = document;
+	return element === activeElement || element.contains(activeElement);
+}
+function syncFocus() {
+	const lastElement = getLastElement();
+	const { activeElement } = document;
+	if (lastElement && !hasFocus(lastElement)) {
+		const focusableList = getFocusNodeList(lastElement);
+		(focusableList.includes(lastFocusElement) ? lastFocusElement : focusableList[0])?.focus();
+	} else lastFocusElement = activeElement;
+}
+function onWindowKeyDown(e) {
+	if (e.key === "Tab") {
+		const { activeElement } = document;
+		const focusableList = getFocusNodeList(getLastElement());
+		const last = focusableList[focusableList.length - 1];
+		if (e.shiftKey && activeElement === focusableList[0]) lastFocusElement = last;
+		else if (!e.shiftKey && activeElement === last) lastFocusElement = focusableList[0];
+	}
+}
+function lockFocus(element) {
+	if (element) {
+		focusElements = focusElements.filter((ele) => ele !== element);
+		focusElements.push(element);
+		window.addEventListener("focusin", syncFocus);
+		window.addEventListener("keydown", onWindowKeyDown, true);
+		syncFocus();
+	}
+	return () => {
+		lastFocusElement = null;
+		focusElements = focusElements.filter((ele) => ele !== element);
+		if (focusElements.length === 0) {
+			window.removeEventListener("focusin", syncFocus);
+			window.removeEventListener("keydown", onWindowKeyDown, true);
+		}
+	};
+}
+function useLockFocus(lock, getElement) {
+	(0, vue.watch)(lock, (_, _o, onCleanup) => {
+		if (lock.value) {
+			const element = getElement();
+			if (element) onCleanup(lockFocus(element));
+		}
+	});
+}
 exports.getFocusNodeList = getFocusNodeList;
-exports.limitTabRange = limitTabRange;
-exports.saveLastFocusNode = saveLastFocusNode;
+exports.lockFocus = lockFocus;
 exports.triggerFocus = triggerFocus;
+exports.useLockFocus = useLockFocus;

package/dist/Dom/focus.d.ts

@@ -1,12 +1,17 @@
+import { Ref } from 'vue';
 export declare function getFocusNodeList(node: HTMLElement, includePositive?: boolean): HTMLElement[];
-/** @deprecated Do not use since this may failed when used in async */
-export declare function saveLastFocusNode(): void;
-/** @deprecated Do not use since this may failed when used in async */
-export declare function clearLastFocusNode(): void;
-/** @deprecated Do not use since this may failed when used in async */
-export declare function backLastFocusNode(): void;
-export declare function limitTabRange(node: HTMLElement, e: KeyboardEvent): void;
 export interface InputFocusOptions extends FocusOptions {
     cursor?: 'start' | 'end' | 'all';
 }
 export declare function triggerFocus(element?: HTMLInputElement | HTMLTextAreaElement, option?: InputFocusOptions): void;
+/**
+ * Lock focus in the element.
+ * It will force back to the first focusable element when focus leaves the element.
+ */
+export declare function lockFocus(element: HTMLElement): VoidFunction;
+/**
+ * Lock focus within an element.
+ * When locked, focus will be restricted to focusable elements within the specified element.
+ * If multiple elements are locked, only the last locked element will be effective.
+ */
+export declare function useLockFocus(lock: Ref<boolean>, getElement: () => HTMLElement | null): void;

package/dist/Dom/focus.js

@@ -1,4 +1,5 @@
 import isVisible_default from "./isVisible.js";
+import { watch } from "vue";
 function focusable(node, includePositive = false) {
 	if (isVisible_default(node)) {
 		const nodeName = node.nodeName.toLowerCase();
@@ -25,27 +26,6 @@ function getFocusNodeList(node, includePositive = false) {
 	if (focusable(node, includePositive)) res.unshift(node);
 	return res;
 }
-var lastFocusElement = null;
-function saveLastFocusNode() {
-	lastFocusElement = document.activeElement;
-}
-function clearLastFocusNode() {
-	lastFocusElement = null;
-}
-function backLastFocusNode() {
-	if (lastFocusElement) try {
-		lastFocusElement.focus();
-	} catch (_e) {}
-}
-function limitTabRange(node, e) {
-	if (e.keyCode === 9) {
-		const tabNodeList = getFocusNodeList(node);
-		if (tabNodeList[e.shiftKey ? 0 : tabNodeList.length - 1] === document.activeElement || node === document.activeElement) {
-			tabNodeList[e.shiftKey ? tabNodeList.length - 1 : 0].focus();
-			e.preventDefault();
-		}
-	}
-}
 function triggerFocus(element, option) {
 	if (!element) return;
 	element.focus(option);
@@ -63,4 +43,55 @@ function triggerFocus(element, option) {
 		}
 	}
 }
-export { backLastFocusNode, clearLastFocusNode, getFocusNodeList, limitTabRange, saveLastFocusNode, triggerFocus };
+var lastFocusElement = null;
+var focusElements = [];
+function getLastElement() {
+	return focusElements[focusElements.length - 1];
+}
+function hasFocus(element) {
+	const { activeElement } = document;
+	return element === activeElement || element.contains(activeElement);
+}
+function syncFocus() {
+	const lastElement = getLastElement();
+	const { activeElement } = document;
+	if (lastElement && !hasFocus(lastElement)) {
+		const focusableList = getFocusNodeList(lastElement);
+		(focusableList.includes(lastFocusElement) ? lastFocusElement : focusableList[0])?.focus();
+	} else lastFocusElement = activeElement;
+}
+function onWindowKeyDown(e) {
+	if (e.key === "Tab") {
+		const { activeElement } = document;
+		const focusableList = getFocusNodeList(getLastElement());
+		const last = focusableList[focusableList.length - 1];
+		if (e.shiftKey && activeElement === focusableList[0]) lastFocusElement = last;
+		else if (!e.shiftKey && activeElement === last) lastFocusElement = focusableList[0];
+	}
+}
+function lockFocus(element) {
+	if (element) {
+		focusElements = focusElements.filter((ele) => ele !== element);
+		focusElements.push(element);
+		window.addEventListener("focusin", syncFocus);
+		window.addEventListener("keydown", onWindowKeyDown, true);
+		syncFocus();
+	}
+	return () => {
+		lastFocusElement = null;
+		focusElements = focusElements.filter((ele) => ele !== element);
+		if (focusElements.length === 0) {
+			window.removeEventListener("focusin", syncFocus);
+			window.removeEventListener("keydown", onWindowKeyDown, true);
+		}
+	};
+}
+function useLockFocus(lock, getElement) {
+	watch(lock, (_, _o, onCleanup) => {
+		if (lock.value) {
+			const element = getElement();
+			if (element) onCleanup(lockFocus(element));
+		}
+	});
+}
+export { getFocusNodeList, lockFocus, triggerFocus, useLockFocus };

package/dist/hooks/useControlledState.cjs

@@ -0,0 +1,19 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let vue = require("vue");
+function useControlledState(state, emit, updateKey = "value", defaultState, props) {
+	const mergedState = (0, vue.shallowRef)(defaultState ?? state.value);
+	function setState(nextState) {
+		if (emit) emit(`update:${updateKey}`, nextState);
+		if (props && props?.[`onUpdate:${updateKey}`]) props?.[`onUpdate:${updateKey}`](nextState);
+		(0, vue.nextTick)(() => {
+			if (state.value === void 0 && state.value !== nextState) mergedState.value = nextState;
+		});
+	}
+	(0, vue.watch)(() => (0, vue.toValue)(state), () => {
+		const prevState = (0, vue.toValue)(mergedState);
+		const nextState = (0, vue.toValue)(state);
+		if (prevState !== nextState) mergedState.value = nextState;
+	});
+	return [state, setState];
+}
+exports.useControlledState = useControlledState;

package/dist/hooks/useControlledState.d.ts

@@ -0,0 +1,2 @@
+import { Ref } from 'vue';
+export declare function useControlledState<T = any>(state: Ref<T | undefined>, emit?: any, updateKey?: string, defaultState?: T, props?: any): readonly [Ref<T, T>, (nextState: T) => void];

package/dist/hooks/useControlledState.js

@@ -0,0 +1,18 @@
+import { nextTick, shallowRef, toValue, watch } from "vue";
+function useControlledState(state, emit, updateKey = "value", defaultState, props) {
+	const mergedState = shallowRef(defaultState ?? state.value);
+	function setState(nextState) {
+		if (emit) emit(`update:${updateKey}`, nextState);
+		if (props && props?.[`onUpdate:${updateKey}`]) props?.[`onUpdate:${updateKey}`](nextState);
+		nextTick(() => {
+			if (state.value === void 0 && state.value !== nextState) mergedState.value = nextState;
+		});
+	}
+	watch(() => toValue(state), () => {
+		const prevState = toValue(mergedState);
+		const nextState = toValue(state);
+		if (prevState !== nextState) mergedState.value = nextState;
+	});
+	return [state, setState];
+}
+export { useControlledState };

package/dist/index.cjs

@@ -4,6 +4,7 @@ const require_raf = require("./raf.cjs");
 const require_omit = require("./omit.cjs");
 const require_RenderComponent = require("./RenderComponent.cjs");
 const require_classnames = require("./classnames.cjs");
+const require_useControlledState = require("./hooks/useControlledState.cjs");
 const require_useId = require("./hooks/useId.cjs");
 const require_useMergedState = require("./hooks/useMergedState.cjs");
 const require_get = require("./utils/get.cjs");
@@ -17,6 +18,7 @@ exports.get = require_get.default;
 exports.omit = require_omit.default;
 exports.raf = require_raf.default;
 exports.set = require_set.default;
+exports.useControlledState = require_useControlledState.useControlledState;
 exports.useId = require_useId.default;
 exports.useMergedState = require_useMergedState.default;
 exports.warning = require_warning.default;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { default as classNames, clsx } from './classnames';
+export { useControlledState } from './hooks/useControlledState';
 export { default as useId } from './hooks/useId';
 export { default as useMergedState } from './hooks/useMergedState';
 export { default as KeyCode } from './KeyCode';

package/dist/index.js

@@ -3,9 +3,10 @@ import raf_default from "./raf.js";
 import omit from "./omit.js";
 import RenderComponent_default from "./RenderComponent.js";
 import classNames, { clsx } from "./classnames.js";
+import { useControlledState } from "./hooks/useControlledState.js";
 import useId_default from "./hooks/useId.js";
 import useMergedState from "./hooks/useMergedState.js";
 import get from "./utils/get.js";
 import set from "./utils/set.js";
 import warning_default from "./warning.js";
-export { KeyCode_default as KeyCode, RenderComponent_default as RenderComponent, classNames, clsx, get, omit, raf_default as raf, set, useId_default as useId, useMergedState, warning_default as warning };
+export { KeyCode_default as KeyCode, RenderComponent_default as RenderComponent, classNames, clsx, get, omit, raf_default as raf, set, useControlledState, useId_default as useId, useMergedState, warning_default as warning };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@v-c/util",
   "type": "module",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Vue3 components utils",
   "publishConfig": {
     "access": "public"