@cck-ui/hooks 0.18.5 → 0.20.0

package/cjs/index.cjs

@@ -1,7 +1,11 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_use_timeout_fn = require("./use-timeout-fn/use-timeout-fn.cjs");
+const require_use_clipboard = require("./use-clipboard/use-clipboard.cjs");
 const require_use_id = require("./use-id/use-id.cjs");
 const require_use_isomorphic_effect = require("./use-isomorphic-effect/use-isomorphic-effect.cjs");
 const require_use_splitter = require("./use-splitter/use-splitter.cjs");
+exports.useClipboard = require_use_clipboard.useClipboard;
 exports.useId = require_use_id.useId;
 exports.useIsomorphicEffect = require_use_isomorphic_effect.useIsomorphicEffect;
 exports.useSplitter = require_use_splitter.useSplitter;
+exports.useTimeoutFn = require_use_timeout_fn.useTimeoutFn;

package/cjs/use-clipboard/use-clipboard.cjs

@@ -0,0 +1,59 @@
+"use client";
+const require_is = require("../utils/is/is.cjs");
+const require_use_timeout_fn = require("../use-timeout-fn/use-timeout-fn.cjs");
+let vue = require("vue");
+//#region packages/@cck-ui/hooks/src/use-clipboard/use-clipboard.ts
+const defaultNavigator = require_is.isClient ? navigator : void 0;
+function useClipboard(options = {}) {
+	const { copiedDuring = 2e3, navigator = defaultNavigator, source } = options;
+	const error = (0, vue.ref)(null);
+	const text = (0, vue.shallowRef)("");
+	const copied = (0, vue.shallowRef)(false);
+	const copyPending = (0, vue.shallowRef)(false);
+	const timeout = require_use_timeout_fn.useTimeoutFn(() => copied.value = false, copiedDuring, { immediate: false });
+	async function copy(value) {
+		const resolvedValue = value ?? (0, vue.toValue)(source);
+		copyPending.value = true;
+		if (!navigator) {
+			error.value = /* @__PURE__ */ new Error("useClipboard: can only be used on client side.");
+			return;
+		}
+		if (typeof resolvedValue !== "string") {
+			error.value = /* @__PURE__ */ new Error("useClipboard: invalid value");
+			return;
+		}
+		if ("clipboard" in navigator) {
+			const clipboardItem = createClipboardItem(resolvedValue);
+			await navigator.clipboard.write([clipboardItem]);
+			copied.value = true;
+			timeout.start();
+			copyPending.value = false;
+		}
+	}
+	function createClipboardItem(value) {
+		if (typeof value === "string") {
+			text.value = value;
+			return new ClipboardItem({ "text/plain": value });
+		}
+		return new ClipboardItem({ "text/plain": value().then((resolvedText = "") => {
+			text.value = resolvedText;
+			return new Blob([resolvedText], { type: "text/plain" });
+		}) });
+	}
+	function reset() {
+		copied.value = false;
+		error.value = null;
+		timeout.clear();
+	}
+	return {
+		error,
+		text: (0, vue.shallowReadonly)(text),
+		copied: (0, vue.shallowReadonly)(copied),
+		copy,
+		reset
+	};
+}
+//#endregion
+exports.useClipboard = useClipboard;
+
+//# sourceMappingURL=use-clipboard.cjs.map

package/cjs/use-clipboard/use-clipboard.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-clipboard.cjs","names":["isClient","useTimeoutFn"],"sources":["../../src/use-clipboard/use-clipboard.ts"],"sourcesContent":["import { MaybeRefOrGetter, ref, Ref, shallowReadonly, shallowRef, toValue } from 'vue'\nimport { useTimeoutFn } from '../use-timeout-fn/use-timeout-fn'\nimport { isClient } from '../utils'\n\ninterface ConfigurableNavigator {\n  navigator?: Navigator\n}\n\nconst defaultNavigator = isClient ? navigator : undefined\n\nexport interface UseClipboardInput<Source> extends ConfigurableNavigator {\n  /**\n   * @description Enable reading clipboard content on copy/cut events\n   * @default false\n   */\n  read?: boolean\n\n  /**\n   * @description Default content to copy when `copy()` is called without arguments\n   */\n  source?: Source\n\n  /**\n   * @description Time in ms after which the copied state will reset\n   * @default 2000\n   */\n  copiedDuring?: number\n}\n\nexport interface UseClipboardReturnValue<Optional> {\n  /**\n   * @description Function to copy value to clipboard\n   */\n  copy: Optional extends true ? (text?: string) => Promise<void> : (text: string) => Promise<void>\n\n  /**\n   * @description Function to reset copied state and error\n   */\n  reset: () => void\n\n  /**\n   * @description Error if copying failed\n   */\n  error: Ref<Error | null>\n\n  /**\n   * @description Boolean indicating if the value was copied successfully\n   */\n  copied: Ref<boolean>\n\n  /**\n   * @description Current clipboard content (when `read: true`)\n   */\n  text: Ref<string>\n}\n\ntype ClipboardValue = string | (() => Promise<string | undefined>)\n\nexport function useClipboard(options?: UseClipboardInput<undefined>): UseClipboardReturnValue<false>\nexport function useClipboard(\n  options: UseClipboardInput<MaybeRefOrGetter<string>>\n): UseClipboardReturnValue<true>\nexport function useClipboard(\n  options: UseClipboardInput<MaybeRefOrGetter<string> | undefined> = {}\n): UseClipboardReturnValue<boolean> {\n  const { copiedDuring = 2000, navigator = defaultNavigator, source } = options\n\n  const error = ref<Error | null>(null)\n  const text = shallowRef('')\n  const copied = shallowRef(false)\n  const copyPending = shallowRef(false)\n  const timeout = useTimeoutFn(() => (copied.value = false), copiedDuring, { immediate: false })\n\n  async function copy(value?: ClipboardValue) {\n    const resolvedValue = value ?? toValue(source)\n    copyPending.value = true\n\n    if (!navigator) {\n      error.value = new Error('useClipboard: can only be used on client side.')\n      return\n    }\n\n    if (typeof resolvedValue !== 'string') {\n      error.value = new Error('useClipboard: invalid value')\n      return\n    }\n\n    if ('clipboard' in navigator) {\n      const clipboardItem = createClipboardItem(resolvedValue)\n      await navigator.clipboard.write([clipboardItem])\n\n      copied.value = true\n      timeout.start()\n      copyPending.value = false\n    }\n  }\n\n  function createClipboardItem(value: ClipboardValue): ClipboardItem {\n    if (typeof value === 'string') {\n      text.value = value\n      return new ClipboardItem({ 'text/plain': value })\n    }\n\n    return new ClipboardItem({\n      'text/plain': value().then((resolvedText = '') => {\n        text.value = resolvedText\n        return new Blob([resolvedText], { type: 'text/plain' })\n      }),\n    })\n  }\n\n  function reset() {\n    copied.value = false\n    error.value = null\n    timeout.clear()\n  }\n\n  return {\n    error,\n    text: shallowReadonly(text),\n    copied: shallowReadonly(copied),\n    copy,\n    reset,\n  }\n}\n"],"mappings":";;;;;AAQA,MAAM,mBAAmBA,WAAAA,WAAW,YAAY,KAAA;AAsDhD,SAAgB,aACd,UAAmE,CAAC,GAClC;CAClC,MAAM,EAAE,eAAe,KAAM,YAAY,kBAAkB,WAAW;CAEtE,MAAM,SAAA,GAAA,IAAA,IAAA,CAA0B,IAAI;CACpC,MAAM,QAAA,GAAA,IAAA,WAAA,CAAkB,EAAE;CAC1B,MAAM,UAAA,GAAA,IAAA,WAAA,CAAoB,KAAK;CAC/B,MAAM,eAAA,GAAA,IAAA,WAAA,CAAyB,KAAK;CACpC,MAAM,UAAUC,uBAAAA,mBAAoB,OAAO,QAAQ,OAAQ,cAAc,EAAE,WAAW,MAAM,CAAC;CAE7F,eAAe,KAAK,OAAwB;EAC1C,MAAM,gBAAgB,UAAA,GAAA,IAAA,QAAA,CAAiB,MAAM;EAC7C,YAAY,QAAQ;EAEpB,IAAI,CAAC,WAAW;GACd,MAAM,wBAAQ,IAAI,MAAM,gDAAgD;GACxE;EACF;EAEA,IAAI,OAAO,kBAAkB,UAAU;GACrC,MAAM,wBAAQ,IAAI,MAAM,6BAA6B;GACrD;EACF;EAEA,IAAI,eAAe,WAAW;GAC5B,MAAM,gBAAgB,oBAAoB,aAAa;GACvD,MAAM,UAAU,UAAU,MAAM,CAAC,aAAa,CAAC;GAE/C,OAAO,QAAQ;GACf,QAAQ,MAAM;GACd,YAAY,QAAQ;EACtB;CACF;CAEA,SAAS,oBAAoB,OAAsC;EACjE,IAAI,OAAO,UAAU,UAAU;GAC7B,KAAK,QAAQ;GACb,OAAO,IAAI,cAAc,EAAE,cAAc,MAAM,CAAC;EAClD;EAEA,OAAO,IAAI,cAAc,EACvB,cAAc,MAAM,CAAC,CAAC,MAAM,eAAe,OAAO;GAChD,KAAK,QAAQ;GACb,OAAO,IAAI,KAAK,CAAC,YAAY,GAAG,EAAE,MAAM,aAAa,CAAC;EACxD,CAAC,EACH,CAAC;CACH;CAEA,SAAS,QAAQ;EACf,OAAO,QAAQ;EACf,MAAM,QAAQ;EACd,QAAQ,MAAM;CAChB;CAEA,OAAO;EACL;EACA,OAAA,GAAA,IAAA,gBAAA,CAAsB,IAAI;EAC1B,SAAA,GAAA,IAAA,gBAAA,CAAwB,MAAM;EAC9B;EACA;CACF;AACF"}

package/cjs/use-timeout-fn/use-timeout-fn.cjs

@@ -0,0 +1,43 @@
+"use client";
+const require_is = require("../utils/is/is.cjs");
+let vue = require("vue");
+//#region packages/@cck-ui/hooks/src/use-timeout-fn/use-timeout-fn.ts
+function useTimeoutFn(callback, delay, options) {
+	const { immediate = false, immediateCallback = false } = options;
+	const isPending = (0, vue.shallowRef)(false);
+	let timer;
+	function clear() {
+		if (timer) {
+			clearTimeout(timer);
+			timer = null;
+		}
+	}
+	function stop() {
+		isPending.value = false;
+		clear();
+	}
+	function start(...args) {
+		if (immediateCallback) callback();
+		clear();
+		isPending.value = true;
+		timer = setTimeout(() => {
+			isPending.value = false;
+			timer = null;
+			callback(...args);
+		}, (0, vue.toValue)(delay));
+	}
+	if (immediate) {
+		isPending.value = true;
+		if (require_is.isClient) start();
+	}
+	return {
+		clear,
+		isPending: (0, vue.shallowReadonly)(isPending),
+		start,
+		stop
+	};
+}
+//#endregion
+exports.useTimeoutFn = useTimeoutFn;
+
+//# sourceMappingURL=use-timeout-fn.cjs.map

package/cjs/use-timeout-fn/use-timeout-fn.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-timeout-fn.cjs","names":["isClient"],"sources":["../../src/use-timeout-fn/use-timeout-fn.ts"],"sourcesContent":["import { MaybeRefOrGetter, Ref, shallowReadonly, shallowRef, toValue } from 'vue'\nimport { isClient } from '../utils'\n\ninterface Stoppable<StartFnArgs extends any[] = any[]> {\n  /**\n   * @description A ref indicate whether a stoppable instance is executing\n   */\n  readonly isPending: Readonly<Ref<boolean>>\n\n  /**\n   * @description Clear the timer\n   */\n  clear: () => void\n\n  /**\n   * @description Stop the effect from executing\n   */\n  stop: () => void\n\n  /**\n   * @description Start the effects\n   */\n  start: (...args: StartFnArgs) => void\n}\n\nexport interface UseTimeoutFnOptions {\n  /**\n   * @description Start the timer immediately\n   * @default false\n   */\n  immediate?: boolean\n\n  /**\n   * @description Execute the callback function at the beginning once\n   * @default false\n   */\n  immediateCallback?: boolean\n}\n\nexport type UseTimeoutFnReturnValue<CallbackFn extends (...args: any[]) => any> = Stoppable<\n  Parameters<CallbackFn> | []\n>\n\nexport function useTimeoutFn<CallbackFn extends (...args: any[]) => any>(\n  callback: CallbackFn,\n  delay: MaybeRefOrGetter<number>,\n  options: UseTimeoutFnOptions\n): UseTimeoutFnReturnValue<CallbackFn> {\n  const { immediate = false, immediateCallback = false } = options\n  const isPending = shallowRef(false)\n\n  let timer: ReturnType<typeof setTimeout> | null\n\n  function clear() {\n    if (timer) {\n      clearTimeout(timer)\n      timer = null\n    }\n  }\n\n  function stop() {\n    isPending.value = false\n    clear()\n  }\n\n  function start(...args: any[]) {\n    if (immediateCallback) {\n      callback()\n    }\n    clear()\n    isPending.value = true\n    timer = setTimeout(() => {\n      isPending.value = false\n      timer = null\n\n      callback(...args)\n    }, toValue(delay))\n  }\n\n  if (immediate) {\n    isPending.value = true\n    if (isClient) {\n      start()\n    }\n  }\n\n  return {\n    clear,\n    isPending: shallowReadonly(isPending),\n    start,\n    stop,\n  }\n}\n"],"mappings":";;;;AA2CA,SAAgB,aACd,UACA,OACA,SACqC;CACrC,MAAM,EAAE,YAAY,OAAO,oBAAoB,UAAU;CACzD,MAAM,aAAA,GAAA,IAAA,WAAA,CAAuB,KAAK;CAElC,IAAI;CAEJ,SAAS,QAAQ;EACf,IAAI,OAAO;GACT,aAAa,KAAK;GAClB,QAAQ;EACV;CACF;CAEA,SAAS,OAAO;EACd,UAAU,QAAQ;EAClB,MAAM;CACR;CAEA,SAAS,MAAM,GAAG,MAAa;EAC7B,IAAI,mBACF,SAAS;EAEX,MAAM;EACN,UAAU,QAAQ;EAClB,QAAQ,iBAAiB;GACvB,UAAU,QAAQ;GAClB,QAAQ;GAER,SAAS,GAAG,IAAI;EAClB,IAAA,GAAA,IAAA,QAAA,CAAW,KAAK,CAAC;CACnB;CAEA,IAAI,WAAW;EACb,UAAU,QAAQ;EAClB,IAAIA,WAAAA,UACF,MAAM;CAEV;CAEA,OAAO;EACL;EACA,YAAA,GAAA,IAAA,gBAAA,CAA2B,SAAS;EACpC;EACA;CACF;AACF"}

package/cjs/utils/is/is.cjs

@@ -0,0 +1,7 @@
+"use client";
+//#region packages/@cck-ui/hooks/src/utils/is/is.ts
+const isClient = typeof window !== "undefined" && typeof document !== "undefined";
+//#endregion
+exports.isClient = isClient;
+
+//# sourceMappingURL=is.cjs.map

package/cjs/utils/is/is.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"is.cjs","names":[],"sources":["../../../src/utils/is/is.ts"],"sourcesContent":["export const isClient = typeof window !== 'undefined' && typeof document !== 'undefined'\n"],"mappings":";;AAAA,MAAa,WAAW,OAAO,WAAW,eAAe,OAAO,aAAa"}

package/esm/index.mjs

@@ -1,4 +1,6 @@
+import { useTimeoutFn } from "./use-timeout-fn/use-timeout-fn.mjs";
+import { useClipboard } from "./use-clipboard/use-clipboard.mjs";
 import { useId } from "./use-id/use-id.mjs";
 import { useIsomorphicEffect } from "./use-isomorphic-effect/use-isomorphic-effect.mjs";
 import { useSplitter } from "./use-splitter/use-splitter.mjs";
-export { useId, useIsomorphicEffect, useSplitter };
+export { useClipboard, useId, useIsomorphicEffect, useSplitter, useTimeoutFn };

package/esm/use-clipboard/use-clipboard.mjs

@@ -0,0 +1,59 @@
+"use client";
+import { isClient } from "../utils/is/is.mjs";
+import { useTimeoutFn } from "../use-timeout-fn/use-timeout-fn.mjs";
+import { ref, shallowReadonly, shallowRef, toValue } from "vue";
+//#region packages/@cck-ui/hooks/src/use-clipboard/use-clipboard.ts
+const defaultNavigator = isClient ? navigator : void 0;
+function useClipboard(options = {}) {
+	const { copiedDuring = 2e3, navigator = defaultNavigator, source } = options;
+	const error = ref(null);
+	const text = shallowRef("");
+	const copied = shallowRef(false);
+	const copyPending = shallowRef(false);
+	const timeout = useTimeoutFn(() => copied.value = false, copiedDuring, { immediate: false });
+	async function copy(value) {
+		const resolvedValue = value ?? toValue(source);
+		copyPending.value = true;
+		if (!navigator) {
+			error.value = /* @__PURE__ */ new Error("useClipboard: can only be used on client side.");
+			return;
+		}
+		if (typeof resolvedValue !== "string") {
+			error.value = /* @__PURE__ */ new Error("useClipboard: invalid value");
+			return;
+		}
+		if ("clipboard" in navigator) {
+			const clipboardItem = createClipboardItem(resolvedValue);
+			await navigator.clipboard.write([clipboardItem]);
+			copied.value = true;
+			timeout.start();
+			copyPending.value = false;
+		}
+	}
+	function createClipboardItem(value) {
+		if (typeof value === "string") {
+			text.value = value;
+			return new ClipboardItem({ "text/plain": value });
+		}
+		return new ClipboardItem({ "text/plain": value().then((resolvedText = "") => {
+			text.value = resolvedText;
+			return new Blob([resolvedText], { type: "text/plain" });
+		}) });
+	}
+	function reset() {
+		copied.value = false;
+		error.value = null;
+		timeout.clear();
+	}
+	return {
+		error,
+		text: shallowReadonly(text),
+		copied: shallowReadonly(copied),
+		copy,
+		reset
+	};
+}
+//#endregion
+export { useClipboard };
+
+//# sourceMappingURL=use-clipboard.mjs.map

package/esm/use-clipboard/use-clipboard.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-clipboard.mjs","names":[],"sources":["../../src/use-clipboard/use-clipboard.ts"],"sourcesContent":["import { MaybeRefOrGetter, ref, Ref, shallowReadonly, shallowRef, toValue } from 'vue'\nimport { useTimeoutFn } from '../use-timeout-fn/use-timeout-fn'\nimport { isClient } from '../utils'\n\ninterface ConfigurableNavigator {\n  navigator?: Navigator\n}\n\nconst defaultNavigator = isClient ? navigator : undefined\n\nexport interface UseClipboardInput<Source> extends ConfigurableNavigator {\n  /**\n   * @description Enable reading clipboard content on copy/cut events\n   * @default false\n   */\n  read?: boolean\n\n  /**\n   * @description Default content to copy when `copy()` is called without arguments\n   */\n  source?: Source\n\n  /**\n   * @description Time in ms after which the copied state will reset\n   * @default 2000\n   */\n  copiedDuring?: number\n}\n\nexport interface UseClipboardReturnValue<Optional> {\n  /**\n   * @description Function to copy value to clipboard\n   */\n  copy: Optional extends true ? (text?: string) => Promise<void> : (text: string) => Promise<void>\n\n  /**\n   * @description Function to reset copied state and error\n   */\n  reset: () => void\n\n  /**\n   * @description Error if copying failed\n   */\n  error: Ref<Error | null>\n\n  /**\n   * @description Boolean indicating if the value was copied successfully\n   */\n  copied: Ref<boolean>\n\n  /**\n   * @description Current clipboard content (when `read: true`)\n   */\n  text: Ref<string>\n}\n\ntype ClipboardValue = string | (() => Promise<string | undefined>)\n\nexport function useClipboard(options?: UseClipboardInput<undefined>): UseClipboardReturnValue<false>\nexport function useClipboard(\n  options: UseClipboardInput<MaybeRefOrGetter<string>>\n): UseClipboardReturnValue<true>\nexport function useClipboard(\n  options: UseClipboardInput<MaybeRefOrGetter<string> | undefined> = {}\n): UseClipboardReturnValue<boolean> {\n  const { copiedDuring = 2000, navigator = defaultNavigator, source } = options\n\n  const error = ref<Error | null>(null)\n  const text = shallowRef('')\n  const copied = shallowRef(false)\n  const copyPending = shallowRef(false)\n  const timeout = useTimeoutFn(() => (copied.value = false), copiedDuring, { immediate: false })\n\n  async function copy(value?: ClipboardValue) {\n    const resolvedValue = value ?? toValue(source)\n    copyPending.value = true\n\n    if (!navigator) {\n      error.value = new Error('useClipboard: can only be used on client side.')\n      return\n    }\n\n    if (typeof resolvedValue !== 'string') {\n      error.value = new Error('useClipboard: invalid value')\n      return\n    }\n\n    if ('clipboard' in navigator) {\n      const clipboardItem = createClipboardItem(resolvedValue)\n      await navigator.clipboard.write([clipboardItem])\n\n      copied.value = true\n      timeout.start()\n      copyPending.value = false\n    }\n  }\n\n  function createClipboardItem(value: ClipboardValue): ClipboardItem {\n    if (typeof value === 'string') {\n      text.value = value\n      return new ClipboardItem({ 'text/plain': value })\n    }\n\n    return new ClipboardItem({\n      'text/plain': value().then((resolvedText = '') => {\n        text.value = resolvedText\n        return new Blob([resolvedText], { type: 'text/plain' })\n      }),\n    })\n  }\n\n  function reset() {\n    copied.value = false\n    error.value = null\n    timeout.clear()\n  }\n\n  return {\n    error,\n    text: shallowReadonly(text),\n    copied: shallowReadonly(copied),\n    copy,\n    reset,\n  }\n}\n"],"mappings":";;;;;AAQA,MAAM,mBAAmB,WAAW,YAAY,KAAA;AAsDhD,SAAgB,aACd,UAAmE,CAAC,GAClC;CAClC,MAAM,EAAE,eAAe,KAAM,YAAY,kBAAkB,WAAW;CAEtE,MAAM,QAAQ,IAAkB,IAAI;CACpC,MAAM,OAAO,WAAW,EAAE;CAC1B,MAAM,SAAS,WAAW,KAAK;CAC/B,MAAM,cAAc,WAAW,KAAK;CACpC,MAAM,UAAU,mBAAoB,OAAO,QAAQ,OAAQ,cAAc,EAAE,WAAW,MAAM,CAAC;CAE7F,eAAe,KAAK,OAAwB;EAC1C,MAAM,gBAAgB,SAAS,QAAQ,MAAM;EAC7C,YAAY,QAAQ;EAEpB,IAAI,CAAC,WAAW;GACd,MAAM,wBAAQ,IAAI,MAAM,gDAAgD;GACxE;EACF;EAEA,IAAI,OAAO,kBAAkB,UAAU;GACrC,MAAM,wBAAQ,IAAI,MAAM,6BAA6B;GACrD;EACF;EAEA,IAAI,eAAe,WAAW;GAC5B,MAAM,gBAAgB,oBAAoB,aAAa;GACvD,MAAM,UAAU,UAAU,MAAM,CAAC,aAAa,CAAC;GAE/C,OAAO,QAAQ;GACf,QAAQ,MAAM;GACd,YAAY,QAAQ;EACtB;CACF;CAEA,SAAS,oBAAoB,OAAsC;EACjE,IAAI,OAAO,UAAU,UAAU;GAC7B,KAAK,QAAQ;GACb,OAAO,IAAI,cAAc,EAAE,cAAc,MAAM,CAAC;EAClD;EAEA,OAAO,IAAI,cAAc,EACvB,cAAc,MAAM,CAAC,CAAC,MAAM,eAAe,OAAO;GAChD,KAAK,QAAQ;GACb,OAAO,IAAI,KAAK,CAAC,YAAY,GAAG,EAAE,MAAM,aAAa,CAAC;EACxD,CAAC,EACH,CAAC;CACH;CAEA,SAAS,QAAQ;EACf,OAAO,QAAQ;EACf,MAAM,QAAQ;EACd,QAAQ,MAAM;CAChB;CAEA,OAAO;EACL;EACA,MAAM,gBAAgB,IAAI;EAC1B,QAAQ,gBAAgB,MAAM;EAC9B;EACA;CACF;AACF"}

package/esm/use-timeout-fn/use-timeout-fn.mjs

@@ -0,0 +1,43 @@
+"use client";
+import { isClient } from "../utils/is/is.mjs";
+import { shallowReadonly, shallowRef, toValue } from "vue";
+//#region packages/@cck-ui/hooks/src/use-timeout-fn/use-timeout-fn.ts
+function useTimeoutFn(callback, delay, options) {
+	const { immediate = false, immediateCallback = false } = options;
+	const isPending = shallowRef(false);
+	let timer;
+	function clear() {
+		if (timer) {
+			clearTimeout(timer);
+			timer = null;
+		}
+	}
+	function stop() {
+		isPending.value = false;
+		clear();
+	}
+	function start(...args) {
+		if (immediateCallback) callback();
+		clear();
+		isPending.value = true;
+		timer = setTimeout(() => {
+			isPending.value = false;
+			timer = null;
+			callback(...args);
+		}, toValue(delay));
+	}
+	if (immediate) {
+		isPending.value = true;
+		if (isClient) start();
+	}
+	return {
+		clear,
+		isPending: shallowReadonly(isPending),
+		start,
+		stop
+	};
+}
+//#endregion
+export { useTimeoutFn };
+
+//# sourceMappingURL=use-timeout-fn.mjs.map

package/esm/use-timeout-fn/use-timeout-fn.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-timeout-fn.mjs","names":[],"sources":["../../src/use-timeout-fn/use-timeout-fn.ts"],"sourcesContent":["import { MaybeRefOrGetter, Ref, shallowReadonly, shallowRef, toValue } from 'vue'\nimport { isClient } from '../utils'\n\ninterface Stoppable<StartFnArgs extends any[] = any[]> {\n  /**\n   * @description A ref indicate whether a stoppable instance is executing\n   */\n  readonly isPending: Readonly<Ref<boolean>>\n\n  /**\n   * @description Clear the timer\n   */\n  clear: () => void\n\n  /**\n   * @description Stop the effect from executing\n   */\n  stop: () => void\n\n  /**\n   * @description Start the effects\n   */\n  start: (...args: StartFnArgs) => void\n}\n\nexport interface UseTimeoutFnOptions {\n  /**\n   * @description Start the timer immediately\n   * @default false\n   */\n  immediate?: boolean\n\n  /**\n   * @description Execute the callback function at the beginning once\n   * @default false\n   */\n  immediateCallback?: boolean\n}\n\nexport type UseTimeoutFnReturnValue<CallbackFn extends (...args: any[]) => any> = Stoppable<\n  Parameters<CallbackFn> | []\n>\n\nexport function useTimeoutFn<CallbackFn extends (...args: any[]) => any>(\n  callback: CallbackFn,\n  delay: MaybeRefOrGetter<number>,\n  options: UseTimeoutFnOptions\n): UseTimeoutFnReturnValue<CallbackFn> {\n  const { immediate = false, immediateCallback = false } = options\n  const isPending = shallowRef(false)\n\n  let timer: ReturnType<typeof setTimeout> | null\n\n  function clear() {\n    if (timer) {\n      clearTimeout(timer)\n      timer = null\n    }\n  }\n\n  function stop() {\n    isPending.value = false\n    clear()\n  }\n\n  function start(...args: any[]) {\n    if (immediateCallback) {\n      callback()\n    }\n    clear()\n    isPending.value = true\n    timer = setTimeout(() => {\n      isPending.value = false\n      timer = null\n\n      callback(...args)\n    }, toValue(delay))\n  }\n\n  if (immediate) {\n    isPending.value = true\n    if (isClient) {\n      start()\n    }\n  }\n\n  return {\n    clear,\n    isPending: shallowReadonly(isPending),\n    start,\n    stop,\n  }\n}\n"],"mappings":";;;;AA2CA,SAAgB,aACd,UACA,OACA,SACqC;CACrC,MAAM,EAAE,YAAY,OAAO,oBAAoB,UAAU;CACzD,MAAM,YAAY,WAAW,KAAK;CAElC,IAAI;CAEJ,SAAS,QAAQ;EACf,IAAI,OAAO;GACT,aAAa,KAAK;GAClB,QAAQ;EACV;CACF;CAEA,SAAS,OAAO;EACd,UAAU,QAAQ;EAClB,MAAM;CACR;CAEA,SAAS,MAAM,GAAG,MAAa;EAC7B,IAAI,mBACF,SAAS;EAEX,MAAM;EACN,UAAU,QAAQ;EAClB,QAAQ,iBAAiB;GACvB,UAAU,QAAQ;GAClB,QAAQ;GAER,SAAS,GAAG,IAAI;EAClB,GAAG,QAAQ,KAAK,CAAC;CACnB;CAEA,IAAI,WAAW;EACb,UAAU,QAAQ;EAClB,IAAI,UACF,MAAM;CAEV;CAEA,OAAO;EACL;EACA,WAAW,gBAAgB,SAAS;EACpC;EACA;CACF;AACF"}

package/esm/utils/is/is.mjs

@@ -0,0 +1,7 @@
+"use client";
+//#region packages/@cck-ui/hooks/src/utils/is/is.ts
+const isClient = typeof window !== "undefined" && typeof document !== "undefined";
+//#endregion
+export { isClient };
+
+//# sourceMappingURL=is.mjs.map

package/esm/utils/is/is.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"is.mjs","names":[],"sources":["../../../src/utils/is/is.ts"],"sourcesContent":["export const isClient = typeof window !== 'undefined' && typeof document !== 'undefined'\n"],"mappings":";;AAAA,MAAa,WAAW,OAAO,WAAW,eAAe,OAAO,aAAa"}

package/lib/index.d.mts

@@ -1,4 +1,6 @@
+export { useClipboard } from './use-clipboard/use-clipboard';
 export { useId } from './use-id/use-id';
 export { useIsomorphicEffect } from './use-isomorphic-effect/use-isomorphic-effect';
 export { useSplitter } from './use-splitter/use-splitter';
+export { useTimeoutFn } from './use-timeout-fn/use-timeout-fn';
 export type { UseSplitterPanel, UseSplitterOptions, UseSplitterReturnValue, UseSplitterRedistributeInput, UseSplitterRedistributeFn, UseSplitterResolvedPanel, SplitterPaneSize, SplitterStep, } from './use-splitter/use-splitter';

package/lib/index.d.ts

@@ -1,4 +1,6 @@
+export { useClipboard } from './use-clipboard/use-clipboard';
 export { useId } from './use-id/use-id';
 export { useIsomorphicEffect } from './use-isomorphic-effect/use-isomorphic-effect';
 export { useSplitter } from './use-splitter/use-splitter';
+export { useTimeoutFn } from './use-timeout-fn/use-timeout-fn';
 export type { UseSplitterPanel, UseSplitterOptions, UseSplitterReturnValue, UseSplitterRedistributeInput, UseSplitterRedistributeFn, UseSplitterResolvedPanel, SplitterPaneSize, SplitterStep, } from './use-splitter/use-splitter';

package/lib/use-clipboard/use-clipboard.d.ts

@@ -0,0 +1,45 @@
+import { MaybeRefOrGetter, Ref } from 'vue';
+interface ConfigurableNavigator {
+    navigator?: Navigator;
+}
+export interface UseClipboardInput<Source> extends ConfigurableNavigator {
+    /**
+     * @description Enable reading clipboard content on copy/cut events
+     * @default false
+     */
+    read?: boolean;
+    /**
+     * @description Default content to copy when `copy()` is called without arguments
+     */
+    source?: Source;
+    /**
+     * @description Time in ms after which the copied state will reset
+     * @default 2000
+     */
+    copiedDuring?: number;
+}
+export interface UseClipboardReturnValue<Optional> {
+    /**
+     * @description Function to copy value to clipboard
+     */
+    copy: Optional extends true ? (text?: string) => Promise<void> : (text: string) => Promise<void>;
+    /**
+     * @description Function to reset copied state and error
+     */
+    reset: () => void;
+    /**
+     * @description Error if copying failed
+     */
+    error: Ref<Error | null>;
+    /**
+     * @description Boolean indicating if the value was copied successfully
+     */
+    copied: Ref<boolean>;
+    /**
+     * @description Current clipboard content (when `read: true`)
+     */
+    text: Ref<string>;
+}
+export declare function useClipboard(options?: UseClipboardInput<undefined>): UseClipboardReturnValue<false>;
+export declare function useClipboard(options: UseClipboardInput<MaybeRefOrGetter<string>>): UseClipboardReturnValue<true>;
+export {};

package/lib/use-timeout-fn/use-timeout-fn.d.ts

@@ -0,0 +1,34 @@
+import { MaybeRefOrGetter, Ref } from 'vue';
+interface Stoppable<StartFnArgs extends any[] = any[]> {
+    /**
+     * @description A ref indicate whether a stoppable instance is executing
+     */
+    readonly isPending: Readonly<Ref<boolean>>;
+    /**
+     * @description Clear the timer
+     */
+    clear: () => void;
+    /**
+     * @description Stop the effect from executing
+     */
+    stop: () => void;
+    /**
+     * @description Start the effects
+     */
+    start: (...args: StartFnArgs) => void;
+}
+export interface UseTimeoutFnOptions {
+    /**
+     * @description Start the timer immediately
+     * @default false
+     */
+    immediate?: boolean;
+    /**
+     * @description Execute the callback function at the beginning once
+     * @default false
+     */
+    immediateCallback?: boolean;
+}
+export type UseTimeoutFnReturnValue<CallbackFn extends (...args: any[]) => any> = Stoppable<Parameters<CallbackFn> | []>;
+export declare function useTimeoutFn<CallbackFn extends (...args: any[]) => any>(callback: CallbackFn, delay: MaybeRefOrGetter<number>, options: UseTimeoutFnOptions): UseTimeoutFnReturnValue<CallbackFn>;
+export {};

package/lib/utils/index.d.ts

@@ -1 +1,2 @@
+export { isClient } from './is/is';
 export { randomId } from './random-id/random-id';

package/lib/utils/is/is.d.ts

@@ -0,0 +1 @@
+export declare const isClient: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cck-ui/hooks",
-  "version": "0.18.5",
+  "version": "0.20.0",
   "description": "A collection of hooks for state and UI management",
   "homepage": "https://cck-ui.jackatlas.xyz",
   "license": "ISC",