foxact 0.2.6 → 0.2.7

package/README.md

@@ -6,7 +6,7 @@ React Hooks/Utils done right. For Browser, SSR, and React Server Components.
 
 ## Documentation
 
-Under construction.
+https://foxact.skk.moe
 
 ## Features
 
@@ -34,7 +34,7 @@ The entire **foxact** library has zero dependencies and is **less than 5 KiB gzi
 
 #### Fully Tree Shakable
 
-Feel free to take what you want from **foxact** without worrying about client bundle size.
+Every hook and util is isolated and side-effects free. Feel free to take what you want from **foxact** without worrying about client bundle size.
 
 ## License
 

package/context-state/index.d.ts

@@ -1,6 +1,7 @@
 import * as react from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
+/** @see https://foxact.skk.moe/context-state */
 declare function createContextState<T>(initialState: T): readonly [({ children }: React.PropsWithChildren) => react_jsx_runtime.JSX.Element, () => T, () => react.Dispatch<react.SetStateAction<T>>];
 
 export { createContextState };

package/create-context-state/index.d.ts

@@ -1 +1,3 @@
-export { createContextState } from '@/context-state';
+export { createContextState } from '../context-state/index.js';
+import 'react';
+import 'react/jsx-runtime';

package/noop/index.d.ts

@@ -1,6 +1,7 @@
 interface Noop {
     (...args: any[]): any;
 }
+/** @see https://foxact.skk.moe/noop */
 declare const noop: Noop;
 
 export { Noop, noop };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foxact",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "React Hooks/Utils done right. For browser, SSR, and React Server Components.",
   "sideEffects": false,
   "files": [
@@ -19,7 +19,7 @@
   "bugs": {
     "url": "https://github.com/SukkaW/foxact/issues"
   },
-  "homepage": "https://github.com/SukkaW/foxact#readme",
+  "homepage": "https://foxact.skk.moe",
   "dependencies": {
     "client-only": "^0.0.1",
     "server-only": "^0.0.1"
@@ -47,15 +47,6 @@
   "exports": {
     "./package.json": "./package.json",
     "./sizes.json": "./sizes.json",
-    "./create-context-state": {
-      "types": "./create-context-state/index.d.ts",
-      "import": {
-        "types": "./create-context-state/index.d.ts",
-        "default": "./create-context-state/index.mjs"
-      },
-      "require": "./create-context-state/index.cjs",
-      "default": "./create-context-state/index.js"
-    },
     "./context-state": {
       "types": "./context-state/index.d.ts",
       "import": {
@@ -65,6 +56,15 @@
       "require": "./context-state/index.cjs",
       "default": "./context-state/index.js"
     },
+    "./create-context-state": {
+      "types": "./create-context-state/index.d.ts",
+      "import": {
+        "types": "./create-context-state/index.d.ts",
+        "default": "./create-context-state/index.mjs"
+      },
+      "require": "./create-context-state/index.cjs",
+      "default": "./create-context-state/index.js"
+    },
     "./noop": {
       "types": "./noop/index.d.ts",
       "import": {

package/request-idle-callback/index.d.ts

@@ -1,4 +1,6 @@
+/** @see https://foxact.skk.moe/request-idle-callback */
 declare const requestIdleCallback: ((callback: IdleRequestCallback, options?: IdleRequestOptions | undefined) => number) & typeof globalThis.requestIdleCallback;
+/** @see https://foxact.skk.moe/request-idle-callback */
 declare const cancelIdleCallback: ((handle: number) => void) & typeof globalThis.cancelIdleCallback;
 
 export { cancelIdleCallback, requestIdleCallback };

package/sizes.json

@@ -1 +1 @@
-{"total":{"raw":5028,"gzip":3341},"exports":{"create-context-state":{"raw":146,"gzip":119},"context-state":{"raw":369,"gzip":240},"noop":{"raw":32,"gzip":52},"request-idle-callback":{"raw":407,"gzip":229},"typescript-happy-forward-ref":{"raw":83,"gzip":91},"use-array":{"raw":329,"gzip":241},"use-clipboard":{"raw":850,"gzip":504},"use-error-boundary":{"raw":172,"gzip":157},"use-intersection":{"raw":1214,"gzip":649},"use-isomorphic-layout-effect":{"raw":177,"gzip":143},"use-map":{"raw":330,"gzip":240},"use-retimer":{"raw":197,"gzip":165},"use-set":{"raw":331,"gzip":236},"use-uncontrolled":{"raw":391,"gzip":275}}}
+{"total":{"raw":5103,"gzip":3367},"exports":{"context-state":{"raw":369,"gzip":240},"create-context-state":{"raw":146,"gzip":119},"noop":{"raw":32,"gzip":52},"request-idle-callback":{"raw":407,"gzip":229},"typescript-happy-forward-ref":{"raw":118,"gzip":102},"use-array":{"raw":329,"gzip":241},"use-clipboard":{"raw":854,"gzip":507},"use-error-boundary":{"raw":172,"gzip":157},"use-intersection":{"raw":1214,"gzip":649},"use-isomorphic-layout-effect":{"raw":177,"gzip":143},"use-map":{"raw":348,"gzip":246},"use-retimer":{"raw":197,"gzip":165},"use-uncontrolled":{"raw":391,"gzip":275},"use-set":{"raw":349,"gzip":242}}}

package/typescript-happy-forward-ref/index.cjs

@@ -1 +1 @@
-"use strict";var r=require("react");const e=r.forwardRef;exports.typeScriptHappyForwardRef=e;
+"use strict";var r=require("react");const e=r.forwardRef,p=r.forwardRef;exports.typeScriptHappyForwardRef=e,exports.typescriptHappyForwardRef=p;

package/typescript-happy-forward-ref/index.d.ts

@@ -1,6 +1,9 @@
 interface TypeScriptHappyForwardRef {
     <T, P = {}>(render: (props: P, ref: React.ForwardedRef<T>) => React.ReactElement | null): (props: P & React.RefAttributes<T>) => React.ReactElement | null;
 }
+/** @see https://foxact.skk.moe/typescript-happy-forward-ref */
 declare const typeScriptHappyForwardRef: TypeScriptHappyForwardRef;
+/** @see https://foxact.skk.moe/typescript-happy-forward-ref */
+declare const typescriptHappyForwardRef: TypeScriptHappyForwardRef;
 
-export { TypeScriptHappyForwardRef, typeScriptHappyForwardRef };
+export { TypeScriptHappyForwardRef, typeScriptHappyForwardRef, typescriptHappyForwardRef };

package/typescript-happy-forward-ref/index.js

@@ -1 +1 @@
-"use strict";var r=require("react");const e=r.forwardRef;exports.typeScriptHappyForwardRef=e;
+"use strict";var r=require("react");const e=r.forwardRef,p=r.forwardRef;exports.typeScriptHappyForwardRef=e,exports.typescriptHappyForwardRef=p;

package/typescript-happy-forward-ref/index.mjs

@@ -1 +1 @@
-import{forwardRef as r}from"react";let p=r;export{p as typeScriptHappyForwardRef};
+import{forwardRef as p}from"react";let r=p,t=p;export{r as typeScriptHappyForwardRef,t as typescriptHappyForwardRef};

package/use-clipboard/index.cjs

@@ -1 +1 @@
-"use strict";require("client-only");var e=require("react");class t extends Error{}exports.UseClipboardError=t,exports.useClipboard=function(){let{timeout:r=1e3,usePromptAsFallback:a=!1,promptFallbackText:l="Failed to copy to clipboard automatically, please manually copy the text below."}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},[o,i]=e.useState(null),[c,u]=e.useState(!1),n=e.useRef(null),s=e.useCallback(e=>{n.current&&clearTimeout(n.current),e&&(n.current=window.setTimeout(()=>u(!1),r)),u(e)},[r]),p=e.useCallback(async e=>{try{if("clipboard"in navigator)await navigator.clipboard.writeText(e),s(!0);else throw new t("[foxact] useClipboard: navigator.clipboard is not supported")}catch(t){if(a)try{window.prompt(l,e)}catch(e){i(e)}else i(t)}},[s]),d=e.useCallback(()=>{u(!1),i(null),n.current&&clearTimeout(n.current)},[]);return{copy:p,reset:d,error:o,copied:c}};
+"use strict";require("client-only");var e=require("react");class t extends Error{}exports.UseClipboardError=t,exports.useClipboard=function(){let{timeout:r=1e3,usePromptAsFallback:a=!1,promptFallbackText:l="Failed to copy to clipboard automatically, please manually copy the text below."}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},[o,i]=e.useState(null),[c,u]=e.useState(!1),n=e.useRef(null),s=e.useCallback(e=>{n.current&&clearTimeout(n.current),e&&(n.current=window.setTimeout(()=>u(!1),r)),u(e)},[r]),p=e.useCallback(async e=>{try{if("clipboard"in navigator)await navigator.clipboard.writeText(e),s(!0);else throw new t("[foxact] useClipboard: navigator.clipboard is not supported")}catch(t){if(a)try{window.prompt(l,e)}catch(e){i(e)}else i(t)}},[s,l,a]),d=e.useCallback(()=>{u(!1),i(null),n.current&&clearTimeout(n.current)},[]);return{copy:p,reset:d,error:o,copied:c}};

package/use-clipboard/index.d.ts

@@ -5,6 +5,7 @@ interface UseClipboardOption {
     usePromptAsFallback?: boolean;
     promptFallbackText?: string;
 }
+/** @see https://foxact.skk.moe/use-clipboard */
 declare function useClipboard({ timeout, usePromptAsFallback, promptFallbackText }?: UseClipboardOption): {
     copy: (valueToCopy: string) => Promise<void>;
     reset: () => void;

package/use-clipboard/index.js

@@ -1 +1 @@
-"use strict";require("client-only");var e=require("react");class t extends Error{}exports.UseClipboardError=t,exports.useClipboard=function(){let{timeout:r=1e3,usePromptAsFallback:a=!1,promptFallbackText:l="Failed to copy to clipboard automatically, please manually copy the text below."}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},[o,i]=e.useState(null),[c,u]=e.useState(!1),n=e.useRef(null),s=e.useCallback(e=>{n.current&&clearTimeout(n.current),e&&(n.current=window.setTimeout(()=>u(!1),r)),u(e)},[r]),p=e.useCallback(async e=>{try{if("clipboard"in navigator)await navigator.clipboard.writeText(e),s(!0);else throw new t("[foxact] useClipboard: navigator.clipboard is not supported")}catch(t){if(a)try{window.prompt(l,e)}catch(e){i(e)}else i(t)}},[s]),d=e.useCallback(()=>{u(!1),i(null),n.current&&clearTimeout(n.current)},[]);return{copy:p,reset:d,error:o,copied:c}};
+"use strict";require("client-only");var e=require("react");class t extends Error{}exports.UseClipboardError=t,exports.useClipboard=function(){let{timeout:r=1e3,usePromptAsFallback:a=!1,promptFallbackText:l="Failed to copy to clipboard automatically, please manually copy the text below."}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},[o,i]=e.useState(null),[c,u]=e.useState(!1),n=e.useRef(null),s=e.useCallback(e=>{n.current&&clearTimeout(n.current),e&&(n.current=window.setTimeout(()=>u(!1),r)),u(e)},[r]),p=e.useCallback(async e=>{try{if("clipboard"in navigator)await navigator.clipboard.writeText(e),s(!0);else throw new t("[foxact] useClipboard: navigator.clipboard is not supported")}catch(t){if(a)try{window.prompt(l,e)}catch(e){i(e)}else i(t)}},[s,l,a]),d=e.useCallback(()=>{u(!1),i(null),n.current&&clearTimeout(n.current)},[]);return{copy:p,reset:d,error:o,copied:c}};

package/use-clipboard/index.mjs

@@ -1 +1 @@
-import"client-only";import{useState as r,useRef as t,useCallback as e}from"react";class o extends Error{}function a(){let{timeout:a=1e3,usePromptAsFallback:l=!1,promptFallbackText:i="Failed to copy to clipboard automatically, please manually copy the text below."}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},[n,c]=r(null),[u,p]=r(!1),d=t(null),s=e(r=>{d.current&&clearTimeout(d.current),r&&(d.current=window.setTimeout(()=>p(!1),a)),p(r)},[a]),m=e(async r=>{try{if("clipboard"in navigator)await navigator.clipboard.writeText(r),s(!0);else throw new o("[foxact] useClipboard: navigator.clipboard is not supported")}catch(t){if(l)try{window.prompt(i,r)}catch(r){c(r)}else c(t)}},[s]),w=e(()=>{p(!1),c(null),d.current&&clearTimeout(d.current)},[]);return{copy:m,reset:w,error:n,copied:u}}export{o as UseClipboardError,a as useClipboard};
+import"client-only";import{useState as r,useRef as t,useCallback as e}from"react";class o extends Error{}function a(){let{timeout:a=1e3,usePromptAsFallback:l=!1,promptFallbackText:i="Failed to copy to clipboard automatically, please manually copy the text below."}=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},[n,c]=r(null),[u,p]=r(!1),d=t(null),s=e(r=>{d.current&&clearTimeout(d.current),r&&(d.current=window.setTimeout(()=>p(!1),a)),p(r)},[a]),m=e(async r=>{try{if("clipboard"in navigator)await navigator.clipboard.writeText(r),s(!0);else throw new o("[foxact] useClipboard: navigator.clipboard is not supported")}catch(t){if(l)try{window.prompt(i,r)}catch(r){c(r)}else c(t)}},[s,i,l]),w=e(()=>{p(!1),c(null),d.current&&clearTimeout(d.current)},[]);return{copy:m,reset:w,error:n,copied:u}}export{o as UseClipboardError,a as useClipboard};

package/use-error-boundary/index.d.ts

@@ -1,6 +1,7 @@
 import * as react from 'react';
 
 type ErrorLike = Error | undefined | null | boolean;
+/** @see https://foxact.skk.moe/use-error-boundary */
 declare const useErrorBoundary: (givenError: ErrorLike) => react.Dispatch<react.SetStateAction<ErrorLike>>;
 
 export { useErrorBoundary };

package/use-intersection/index.d.ts

@@ -4,6 +4,7 @@ type UseIntersectionArgs = {
 } & UseIntersectionObserverInit & {
     rootRef?: React.RefObject<HTMLElement> | null;
 };
+/** @see https://foxact.skk.moe/use-intersection */
 declare function useIntersection<T extends Element>({ rootRef, rootMargin, disabled }: UseIntersectionArgs): [(element: T | null) => void, boolean, () => void];
 
 export { useIntersection };

package/use-isomorphic-layout-effect/index.d.ts

@@ -1,6 +1,8 @@
 import { useEffect } from 'react';
 
+/** @see https://foxact.skk.moe/use-isomorphic-layout-effect */
 declare const useIsomorphicLayoutEffect: typeof useEffect;
+/** @see https://foxact.skk.moe/use-isomorphic-layout-effect */
 declare const useLayoutEffect: typeof useEffect;
 
 export { useIsomorphicLayoutEffect, useLayoutEffect };

package/use-map/index.cjs

@@ -1 +1 @@
-"use strict";require("client-only");var e=require("react");exports.useMap=function(){let a=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Map,[t,l]=e.useState(a),n=e.useCallback((e,a)=>l(t=>(t.set(e,a),new Map(t))),[]),r=e.useCallback(e=>l(a=>a.has(e)?(a.delete(e),new Map(a)):a),[]),s=e.useCallback(()=>l(new Map),[]);return[t,n,r,s]};
+"use strict";require("client-only");var e=require("react");exports.useMap=function(){let a=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Map,[l,t]=e.useState(a),s=e.useCallback((e,a)=>t(l=>(l.set(e,a),new Map(l))),[]),u=e.useCallback(e=>t(a=>a.has(e)?(a.delete(e),new Map(a)):a),[]),n=e.useCallback(()=>t(new Map),[]),r=e.useCallback(e=>t(e),[]);return[l,s,u,n,r]};

package/use-map/index.d.ts

@@ -1,3 +1,3 @@
-declare const useMap: <K, T>(initialState?: Map<K, T> | (() => Map<K, T>)) => readonly [Map<K, T>, (k: K, v: T) => void, (k: K) => void, () => void];
+declare const useMap: <K, T>(initialState?: Map<K, T> | (() => Map<K, T>)) => readonly [Map<K, T>, (k: K, v: T) => void, (k: K) => void, () => void, (m: Map<K, T>) => void];
 
 export { useMap };

package/use-map/index.js

@@ -1 +1 @@
-"use strict";require("client-only");var e=require("react");exports.useMap=function(){let a=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Map,[t,l]=e.useState(a),n=e.useCallback((e,a)=>l(t=>(t.set(e,a),new Map(t))),[]),r=e.useCallback(e=>l(a=>a.has(e)?(a.delete(e),new Map(a)):a),[]),s=e.useCallback(()=>l(new Map),[]);return[t,n,r,s]};
+"use strict";require("client-only");var e=require("react");exports.useMap=function(){let a=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Map,[l,t]=e.useState(a),s=e.useCallback((e,a)=>t(l=>(l.set(e,a),new Map(l))),[]),u=e.useCallback(e=>t(a=>a.has(e)?(a.delete(e),new Map(a)):a),[]),n=e.useCallback(()=>t(new Map),[]),r=e.useCallback(e=>t(e),[]);return[l,s,u,n,r]};

package/use-map/index.mjs

@@ -1 +1 @@
-import"client-only";import{useState as e,useCallback as t}from"react";let n=function(){let n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Map,[p,a]=e(n),o=t((e,t)=>a(n=>(n.set(e,t),new Map(n))),[]),r=t(e=>a(t=>t.has(e)?(t.delete(e),new Map(t)):t),[]),l=t(()=>a(new Map),[]);return[p,o,r,l]};export{n as useMap};
+import"client-only";import{useState as e,useCallback as t}from"react";let n=function(){let n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Map,[p,a]=e(n),o=t((e,t)=>a(n=>(n.set(e,t),new Map(n))),[]),r=t(e=>a(t=>t.has(e)?(t.delete(e),new Map(t)):t),[]),l=t(()=>a(new Map),[]),i=t(e=>a(e),[]);return[p,o,r,l,i]};export{n as useMap};

package/use-retimer/index.d.ts

@@ -1,3 +1,4 @@
+/** @see https://foxact.skk.moe/use-retimer */
 declare const useRetimer: () => (timerId: number) => void;
 
 export { useRetimer };

package/use-set/index.cjs

@@ -1 +1 @@
-"use strict";require("client-only");var e=require("react");exports.useSet=function(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Set,[a,l]=e.useState(t),n=e.useCallback(e=>l(t=>t.has(e)?t:new Set([...t,e])),[]),r=e.useCallback(e=>l(t=>t.has(e)?(t.delete(e),new Set(t)):t),[]),s=e.useCallback(()=>l(new Set),[]);return[a,n,r,s]};
+"use strict";require("client-only");var e=require("react");exports.useSet=function(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Set,[a,l]=e.useState(t),s=e.useCallback(e=>l(t=>t.has(e)?t:new Set([...t,e])),[]),u=e.useCallback(e=>l(t=>t.has(e)?(t.delete(e),new Set(t)):t),[]),n=e.useCallback(()=>l(new Set),[]),r=e.useCallback(e=>l(e),[]);return[a,s,u,n,r]};

package/use-set/index.d.ts

@@ -1,3 +1,3 @@
-declare const useSet: <T>(initialState?: Set<T> | (() => Set<T>)) => readonly [Set<T>, (item: T) => void, (item: T) => void, () => void];
+declare const useSet: <T>(initialState?: Set<T> | (() => Set<T>)) => readonly [Set<T>, (item: T) => void, (item: T) => void, () => void, (s: Set<T>) => void];
 
 export { useSet };

package/use-set/index.js

@@ -1 +1 @@
-"use strict";require("client-only");var e=require("react");exports.useSet=function(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Set,[a,l]=e.useState(t),n=e.useCallback(e=>l(t=>t.has(e)?t:new Set([...t,e])),[]),r=e.useCallback(e=>l(t=>t.has(e)?(t.delete(e),new Set(t)):t),[]),s=e.useCallback(()=>l(new Set),[]);return[a,n,r,s]};
+"use strict";require("client-only");var e=require("react");exports.useSet=function(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Set,[a,l]=e.useState(t),s=e.useCallback(e=>l(t=>t.has(e)?t:new Set([...t,e])),[]),u=e.useCallback(e=>l(t=>t.has(e)?(t.delete(e),new Set(t)):t),[]),n=e.useCallback(()=>l(new Set),[]),r=e.useCallback(e=>l(e),[]);return[a,s,u,n,r]};

package/use-set/index.mjs

@@ -1 +1 @@
-import"client-only";import{useState as e,useCallback as t}from"react";let n=function(){let n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Set,[o,r]=e(n),l=t(e=>r(t=>t.has(e)?t:new Set([...t,e])),[]),i=t(e=>r(t=>t.has(e)?(t.delete(e),new Set(t)):t),[]),S=t(()=>r(new Set),[]);return[o,l,i,S]};export{n as useSet};
+import"client-only";import{useState as e,useCallback as t}from"react";let n=function(){let n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:()=>new Set,[o,r]=e(n),l=t(e=>r(t=>t.has(e)?t:new Set([...t,e])),[]),i=t(e=>r(t=>t.has(e)?(t.delete(e),new Set(t)):t),[]),S=t(()=>r(new Set),[]),w=t(e=>r(e),[]);return[o,l,i,S,w]};export{n as useSet};

package/use-uncontrolled/index.d.ts

@@ -1,5 +1,6 @@
 import * as react from 'react';
 
+/** @see https://foxact.skk.moe/use-uncontrolled */
 declare function useUncontrolled<T, E extends HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement = HTMLInputElement>(initialValue: T, transformValue?: (value: T) => T): readonly [T, () => void, react.RefObject<E>];
 
 export { useUncontrolled };