@siberiacancode/reactuse 0.3.3 → 0.3.4

package/dist/esm/hooks/useUrlSearchParams/useUrlSearchParams.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"useUrlSearchParams.mjs","sources":["../../../../src/hooks/useUrlSearchParams/useUrlSearchParams.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport {\n  createQueryString,\n  dispatchUrlSearchParamsEvent,\n  getUrlSearchParams,\n  URL_SEARCH_PARAMS_EVENT\n} from '../useUrlSearchParam/useUrlSearchParam';\n\n/** The url params type */\nexport type UrlParams = Record<string, any>;\n\n/** The url search params mod */\nexport type UrlSearchParamsMode = 'hash-params' | 'hash' | 'history';\n\n/** The use url search params set options type */\nexport interface UseUrlSearchParamsSetOptions {\n  /** The mode to use for writing to the URL */\n  write?: 'push' | 'replace';\n}\n\n/* The use search params initial value type */\nexport type UseUrlSearchParamsInitialValue<Value> = (() => Value) | Value;\n\n/** The use url search params options type */\nexport interface UseUrlSearchParamsOptions<Value> {\n  /* The initial value of the url search params */\n  initialValue?: UseUrlSearchParamsInitialValue<string | URLSearchParams | Value>;\n  /** The mode to use for writing to the URL */\n  mode?: UrlSearchParamsMode;\n  /** The mode to use for writing to the URL  */\n  write?: 'push' | 'replace';\n  /* The deserializer function to be invoked */\n  deserializer?: (value: string) => Value[keyof Value];\n  /* The serializer function to be invoked */\n  serializer?: (value: Value[keyof Value]) => string;\n}\n\n/** The use url search params return type */\nexport interface UseUrlSearchParamsReturn<Value> {\n  /** The value of the url search params */\n  value: Value;\n  /** The set function */\n  set: (value: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => void;\n}\n\nexport interface UseUrlSearchParams {\n  <Value>(\n    key: string,\n    options: UseUrlSearchParamsOptions<Value> & {\n      initialValue: UseUrlSearchParamsInitialValue<Value>;\n    }\n  ): UseUrlSearchParamsReturn<Value>;\n\n  <Value>(options?: UseUrlSearchParamsOptions<Value>): UseUrlSearchParamsReturn<Value | undefined>;\n\n  <Value>(initialValue: UseUrlSearchParamsInitialValue<Value>): UseUrlSearchParamsReturn<Value>;\n\n  <Value>(key: string): UseUrlSearchParamsReturn<Value | undefined>;\n}\n\n/**\n * @name useUrlSearchParams\n * @description - Hook that provides reactive URLSearchParams\n * @category State\n * @usage high\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsOptions<Value> & { initialValue: UseUrlSearchParamsInitialValue<Value> }} options The options object with required initialValue\n * @param {UseUrlSearchParamsInitialValue<Value>} [options.initialValue] The initial value for the url params\n * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')\n * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL\n * @param {(value: Value[keyof Value]) => string} [options.serializer] Custom serializer function to convert value to string\n * @param {(value: string) => Value[keyof Value]} [options.deserializer] Custom deserializer function to convert string to value\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ initialValue: { page: 1 } });\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsInitialValue<Value>} [initialValue] The initial value for the url params\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ page: 1 });\n */\nexport const useUrlSearchParams = (<Value extends UrlParams>(\n  params: any\n): UseUrlSearchParamsReturn<Value> => {\n  const options = (\n    typeof params === 'object' &&\n    params &&\n    ('serializer' in params ||\n      'deserializer' in params ||\n      'initialValue' in params ||\n      'mode' in params ||\n      'write' in params)\n      ? params\n      : {}\n  ) as UseUrlSearchParamsOptions<Value>;\n  const initialValue = (\n    options ? options?.initialValue : params\n  ) as UseUrlSearchParamsInitialValue<Value>;\n\n  const { mode = 'history', write: writeMode = 'replace' } = options;\n\n  const serializer = (value: Value[keyof Value]) => {\n    if (options?.serializer) return options.serializer(value);\n    if (typeof value === 'string') return value;\n    return JSON.stringify(value);\n  };\n\n  const deserializer = (value: string) => {\n    if (options?.deserializer) return options.deserializer(value);\n    if (value === 'undefined') return undefined as unknown as Value[keyof Value];\n\n    try {\n      return JSON.parse(value) as Value;\n    } catch {\n      return value as Value[keyof Value];\n    }\n  };\n\n  const setUrlSearchParams = <Value extends UrlParams>(\n    mode: UrlSearchParamsMode,\n    value: Partial<Value>,\n    write: 'push' | 'replace' = 'replace'\n  ) => {\n    const urlSearchParams = getUrlSearchParams(mode);\n\n    Object.entries(value).forEach(([key, param]) => {\n      if (param === undefined) {\n        urlSearchParams.delete(key);\n      } else {\n        const serializedValue = serializer ? serializer(param) : String(param);\n        urlSearchParams.set(key, serializedValue);\n      }\n    });\n\n    const query = createQueryString(urlSearchParams, mode);\n    if (write === 'replace') window.history.replaceState({}, '', query);\n    if (write === 'push') window.history.pushState({}, '', query);\n    dispatchUrlSearchParamsEvent();\n\n    return urlSearchParams;\n  };\n\n  const getParsedUrlSearchParams = (searchParams: string | UrlParams | URLSearchParams) => {\n    if (typeof searchParams === 'string') {\n      return getParsedUrlSearchParams(new URLSearchParams(searchParams));\n    }\n\n    if (searchParams instanceof URLSearchParams) {\n      return Array.from(searchParams.entries()).reduce(\n        (acc, [key, value]) => {\n          acc[key] = deserializer(value);\n          return acc;\n        },\n        {} as Record<string, any>\n      );\n    }\n\n    return searchParams;\n  };\n\n  const [value, setValue] = useState<Value>(() => {\n    if (typeof window === 'undefined') return (initialValue ?? {}) as Value;\n\n    const urlSearchParams = getUrlSearchParams(mode);\n    const value = {\n      ...(initialValue && getParsedUrlSearchParams(initialValue)),\n      ...getParsedUrlSearchParams(urlSearchParams)\n    } as Value;\n\n    setUrlSearchParams(mode, value, writeMode);\n\n    return value;\n  });\n\n  const set = (params: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => {\n    const searchParams = setUrlSearchParams(\n      mode,\n      { ...value, ...params },\n      options?.write ?? writeMode\n    );\n    setValue(getParsedUrlSearchParams(searchParams) as Value);\n  };\n\n  useEffect(() => {\n    const onParamsChange = () => {\n      const searchParams = getUrlSearchParams(mode);\n      setValue(getParsedUrlSearchParams(searchParams) as Value);\n    };\n\n    window.addEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n    window.addEventListener('popstate', onParamsChange);\n    if (mode !== 'history') window.addEventListener('hashchange', onParamsChange);\n\n    return () => {\n      window.removeEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n      window.removeEventListener('popstate', onParamsChange);\n      if (mode !== 'history') window.removeEventListener('hashchange', onParamsChange);\n    };\n  }, [mode]);\n\n  return {\n    value,\n    set\n  };\n}) as UseUrlSearchParams;\n\nexport { createQueryString, dispatchUrlSearchParamsEvent, getUrlSearchParams };\n"],"names":["useUrlSearchParams","params","options","initialValue","mode","writeMode","serializer","value","deserializer","setUrlSearchParams","write","urlSearchParams","getUrlSearchParams","key","param","serializedValue","query","createQueryString","dispatchUrlSearchParamsEvent","getParsedUrlSearchParams","searchParams","acc","setValue","useState","set","useEffect","onParamsChange","URL_SEARCH_PARAMS_EVENT"],"mappings":";;AAwFO,MAAMA,IAAsB,CACjCC,MACoC;AACpC,QAAMC,IACJ,OAAOD,KAAW,YAClBA,MACC,gBAAgBA,KACf,kBAAkBA,KAClB,kBAAkBA,KAClB,UAAUA,KACV,WAAWA,KACTA,IACA,CAAA,GAEAE,IACJD,IAAUA,GAAS,eAAeD,GAG9B,EAAE,MAAAG,IAAO,WAAW,OAAOC,IAAY,cAAcH,GAErDI,IAAa,CAACC,MACdL,GAAS,aAAmBA,EAAQ,WAAWK,CAAK,IACpD,OAAOA,KAAU,WAAiBA,IAC/B,KAAK,UAAUA,CAAK,GAGvBC,IAAe,CAACD,MAAkB;AACtC,QAAIL,GAAS,aAAc,QAAOA,EAAQ,aAAaK,CAAK;AAC5D,QAAIA,MAAU;AAEd,UAAI;AACF,eAAO,KAAK,MAAMA,CAAK;AAAA,MAAA,QACjB;AACN,eAAOA;AAAAA,MAAA;AAAA,EACT,GAGIE,IAAqB,CACzBL,GACAG,GACAG,IAA4B,cACzB;AACH,UAAMC,IAAkBC,EAAmBR,CAAI;AAE/C,WAAO,QAAQG,CAAK,EAAE,QAAQ,CAAC,CAACM,GAAKC,CAAK,MAAM;AAC9C,UAAIA,MAAU;AACZ,QAAAH,EAAgB,OAAOE,CAAG;AAAA,WACrB;AACL,cAAME,IAAkBT,IAAaA,EAAWQ,CAAK,IAAI,OAAOA,CAAK;AACrE,QAAAH,EAAgB,IAAIE,GAAKE,CAAe;AAAA,MAAA;AAAA,IAC1C,CACD;AAED,UAAMC,IAAQC,EAAkBN,GAAiBP,CAAI;AACrD,WAAIM,MAAU,aAAW,OAAO,QAAQ,aAAa,CAAA,GAAI,IAAIM,CAAK,GAC9DN,MAAU,UAAQ,OAAO,QAAQ,UAAU,CAAA,GAAI,IAAIM,CAAK,GAC5DE,EAAA,GAEOP;AAAA,EAAA,GAGHQ,IAA2B,CAACC,MAC5B,OAAOA,KAAiB,WACnBD,EAAyB,IAAI,gBAAgBC,CAAY,CAAC,IAG/DA,aAAwB,kBACnB,MAAM,KAAKA,EAAa,QAAA,CAAS,EAAE;AAAA,IACxC,CAACC,GAAK,CAACR,GAAKN,CAAK,OACfc,EAAIR,CAAG,IAAIL,EAAaD,CAAK,GACtBc;AAAA,IAET,CAAA;AAAA,EAAC,IAIED,GAGH,CAACb,GAAOe,CAAQ,IAAIC,EAAgB,MAAM;AAC9C,QAAI,OAAO,SAAW,IAAa,QAAQpB,KAAgB,CAAA;AAE3D,UAAMQ,IAAkBC,EAAmBR,CAAI,GACzCG,IAAQ;AAAA,MACZ,GAAIJ,KAAgBgB,EAAyBhB,CAAY;AAAA,MACzD,GAAGgB,EAAyBR,CAAe;AAAA,IAAA;AAG7C,WAAAF,EAAmBL,GAAMG,GAAOF,CAAS,GAElCE;AAAAA,EAAA,CACR,GAEKiB,IAAM,CAACvB,GAAwBC,MAA2C;AAC9E,UAAMkB,IAAeX;AAAA,MACnBL;AAAA,MACA,EAAE,GAAGG,GAAO,GAAGN,EAAAA;AAAAA,MACfC,GAAS,SAASG;AAAA,IAAA;AAEpB,IAAAiB,EAASH,EAAyBC,CAAY,CAAU;AAAA,EAAA;AAG1D,SAAAK,EAAU,MAAM;AACd,UAAMC,IAAiB,MAAM;AAC3B,YAAMN,IAAeR,EAAmBR,CAAI;AAC5C,MAAAkB,EAASH,EAAyBC,CAAY,CAAU;AAAA,IAAA;AAG1D,kBAAO,iBAAiBO,GAAyBD,CAAc,GAC/D,OAAO,iBAAiB,YAAYA,CAAc,GAC9CtB,MAAS,aAAW,OAAO,iBAAiB,cAAcsB,CAAc,GAErE,MAAM;AACX,aAAO,oBAAoBC,GAAyBD,CAAc,GAClE,OAAO,oBAAoB,YAAYA,CAAc,GACjDtB,MAAS,aAAW,OAAO,oBAAoB,cAAcsB,CAAc;AAAA,IAAA;AAAA,EACjF,GACC,CAACtB,CAAI,CAAC,GAEF;AAAA,IACL,OAAAG;AAAA,IACA,KAAAiB;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"useUrlSearchParams.mjs","sources":["../../../../src/hooks/useUrlSearchParams/useUrlSearchParams.ts"],"sourcesContent":["import { useEffect, useState } from 'react';\n\nimport {\n  createQueryString,\n  dispatchUrlSearchParamsEvent,\n  getUrlSearchParams,\n  URL_SEARCH_PARAMS_EVENT\n} from '../useUrlSearchParam/useUrlSearchParam';\n\n/** The url params type */\nexport type UrlParams = Record<string, any>;\n\n/** The url search params mod */\nexport type UrlSearchParamsMode = 'hash-params' | 'hash' | 'history';\n\n/** The use url search params set options type */\nexport interface UseUrlSearchParamsSetOptions {\n  /** The mode to use for writing to the URL */\n  write?: 'push' | 'replace';\n}\n\n/* The use search params initial value type */\nexport type UseUrlSearchParamsInitialValue<Value> = (() => Value) | Value;\n\n/** The use url search params options type */\nexport interface UseUrlSearchParamsOptions<Value> {\n  /* The initial value of the url search params */\n  initialValue?: UseUrlSearchParamsInitialValue<string | URLSearchParams | Value>;\n  /** The mode to use for writing to the URL */\n  mode?: UrlSearchParamsMode;\n  /** The mode to use for writing to the URL  */\n  write?: 'push' | 'replace';\n  /* The deserializer function to be invoked */\n  deserializer?: (value: string) => Value[keyof Value];\n  /* The serializer function to be invoked */\n  serializer?: (value: Value[keyof Value]) => string;\n}\n\n/** The use url search params return type */\nexport interface UseUrlSearchParamsReturn<Value> {\n  /** The value of the url search params */\n  value: Value;\n  /** The set function */\n  set: (value: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => void;\n}\n\nexport interface UseUrlSearchParams {\n  <Value>(\n    key: string,\n    options: UseUrlSearchParamsOptions<Value> & {\n      initialValue: UseUrlSearchParamsInitialValue<Value>;\n    }\n  ): UseUrlSearchParamsReturn<Value>;\n\n  <Value>(options?: UseUrlSearchParamsOptions<Value>): UseUrlSearchParamsReturn<Value | undefined>;\n\n  <Value>(initialValue: UseUrlSearchParamsInitialValue<Value>): UseUrlSearchParamsReturn<Value>;\n\n  <Value>(key: string): UseUrlSearchParamsReturn<Value | undefined>;\n}\n\n/**\n * @name useUrlSearchParams\n * @description - Hook that provides reactive URLSearchParams\n * @category State\n * @usage high\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsOptions<Value> & { initialValue: UseUrlSearchParamsInitialValue<Value> }} options The options object with required initialValue\n * @param {UseUrlSearchParamsInitialValue<Value>} [options.initialValue] The initial value for the url params\n * @param {UrlSearchParamsMode} [options.mode='history'] The mode to use for the URL ('history' | 'hash-params' | 'hash')\n * @param {'push' | 'replace'} [options.write='replace'] The mode to use for writing to the URL\n * @param {(value: Value[keyof Value]) => string} [options.serializer] Custom serializer function to convert value to string\n * @param {(value: string) => Value[keyof Value]} [options.deserializer] Custom deserializer function to convert string to value\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ initialValue: { page: 1 } });\n *\n * @overload\n * @template Value The type of the url param values\n * @param {UseUrlSearchParamsInitialValue<Value>} [initialValue] The initial value for the url params\n * @returns {UseUrlSearchParamsReturn<Value>} The object with value and function for change value\n *\n * @example\n * const { value, set } = useUrlSearchParams({ page: 1 });\n */\nexport const useUrlSearchParams = (<Value extends UrlParams>(\n  params: any\n): UseUrlSearchParamsReturn<Value> => {\n  const options = (\n    typeof params === 'object' &&\n    params &&\n    ('serializer' in params ||\n      'deserializer' in params ||\n      'initialValue' in params ||\n      'mode' in params ||\n      'write' in params)\n      ? params\n      : {}\n  ) as UseUrlSearchParamsOptions<Value>;\n  const initialValue = (\n    options ? options?.initialValue : params\n  ) as UseUrlSearchParamsInitialValue<Value>;\n\n  const { mode = 'history', write: writeMode = 'replace' } = options;\n\n  const serializer = (value: Value[keyof Value]) => {\n    if (options?.serializer) return options.serializer(value);\n    if (typeof value === 'string') return value;\n    return JSON.stringify(value);\n  };\n\n  const deserializer = (value: string) => {\n    if (options?.deserializer) return options.deserializer(value);\n    if (value === 'undefined') return undefined as unknown as Value[keyof Value];\n\n    try {\n      return JSON.parse(value) as Value;\n    } catch {\n      return value as Value[keyof Value];\n    }\n  };\n\n  const setUrlSearchParams = <Value extends UrlParams>(\n    mode: UrlSearchParamsMode,\n    value: Partial<Value>,\n    write: 'push' | 'replace' = 'replace'\n  ) => {\n    const urlSearchParams = getUrlSearchParams(mode);\n\n    Object.entries(value).forEach(([key, param]) => {\n      if (param === undefined) {\n        urlSearchParams.delete(key);\n      } else {\n        const serializedValue = serializer ? serializer(param) : String(param);\n        urlSearchParams.set(key, serializedValue);\n      }\n    });\n\n    const query = createQueryString(urlSearchParams, mode);\n    if (write === 'replace') window.history.replaceState({}, '', query);\n    if (write === 'push') window.history.pushState({}, '', query);\n    dispatchUrlSearchParamsEvent();\n\n    return urlSearchParams;\n  };\n\n  const getParsedUrlSearchParams = (searchParams: string | UrlParams | URLSearchParams) => {\n    if (typeof searchParams === 'string') {\n      return getParsedUrlSearchParams(new URLSearchParams(searchParams));\n    }\n\n    if (searchParams instanceof URLSearchParams) {\n      return Array.from(searchParams.entries()).reduce(\n        (acc, [key, value]) => {\n          acc[key] = deserializer(value);\n          return acc;\n        },\n        {} as Record<string, any>\n      );\n    }\n\n    return searchParams;\n  };\n\n  const [value, setValue] = useState<Value>(() => {\n    if (typeof window === 'undefined') return (initialValue ?? {}) as Value;\n\n    const urlSearchParams = getUrlSearchParams(mode);\n    const value = {\n      ...(initialValue && getParsedUrlSearchParams(initialValue)),\n      ...getParsedUrlSearchParams(urlSearchParams)\n    } as Value;\n\n    setUrlSearchParams(mode, value, writeMode);\n\n    return value;\n  });\n\n  const set = (params: Partial<Value>, options?: UseUrlSearchParamsSetOptions) => {\n    const searchParams = setUrlSearchParams(\n      mode,\n      { ...value, ...params },\n      options?.write ?? writeMode\n    );\n    setValue(getParsedUrlSearchParams(searchParams) as Value);\n  };\n\n  useEffect(() => {\n    const onParamsChange = () => {\n      const searchParams = getUrlSearchParams(mode);\n      setValue(getParsedUrlSearchParams(searchParams) as Value);\n    };\n\n    window.addEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n    window.addEventListener('popstate', onParamsChange);\n    if (mode !== 'history') window.addEventListener('hashchange', onParamsChange);\n\n    return () => {\n      window.removeEventListener(URL_SEARCH_PARAMS_EVENT, onParamsChange);\n      window.removeEventListener('popstate', onParamsChange);\n      if (mode !== 'history') window.removeEventListener('hashchange', onParamsChange);\n    };\n  }, [mode]);\n\n  return {\n    value,\n    set\n  };\n}) as UseUrlSearchParams;\n\nexport { createQueryString, dispatchUrlSearchParamsEvent, getUrlSearchParams };\n"],"names":["useUrlSearchParams","params","options","initialValue","mode","writeMode","serializer","value","deserializer","setUrlSearchParams","write","urlSearchParams","getUrlSearchParams","key","param","serializedValue","query","createQueryString","dispatchUrlSearchParamsEvent","getParsedUrlSearchParams","searchParams","acc","setValue","useState","set","useEffect","onParamsChange","URL_SEARCH_PARAMS_EVENT"],"mappings":";;AAwFO,MAAMA,KAAsB,CACjCC,MACoC;AACpC,QAAMC,IACJ,OAAOD,KAAW,YAClBA,MACC,gBAAgBA,KACf,kBAAkBA,KAClB,kBAAkBA,KAClB,UAAUA,KACV,WAAWA,KACTA,IACA,CAAA,GAEAE,IACJD,IAAUA,GAAS,eAAeD,GAG9B,EAAE,MAAAG,IAAO,WAAW,OAAOC,IAAY,cAAcH,GAErDI,IAAa,CAACC,MACdL,GAAS,aAAmBA,EAAQ,WAAWK,CAAK,IACpD,OAAOA,KAAU,WAAiBA,IAC/B,KAAK,UAAUA,CAAK,GAGvBC,IAAe,CAACD,MAAkB;AACtC,QAAIL,GAAS,aAAc,QAAOA,EAAQ,aAAaK,CAAK;AAC5D,QAAIA,MAAU;AAEd,UAAI;AACF,eAAO,KAAK,MAAMA,CAAK;AAAA,MAAA,QACjB;AACN,eAAOA;AAAAA,MAAA;AAAA,EACT,GAGIE,IAAqB,CACzBL,GACAG,GACAG,IAA4B,cACzB;AACH,UAAMC,IAAkBC,EAAmBR,CAAI;AAE/C,WAAO,QAAQG,CAAK,EAAE,QAAQ,CAAC,CAACM,GAAKC,CAAK,MAAM;AAC9C,UAAIA,MAAU;AACZ,QAAAH,EAAgB,OAAOE,CAAG;AAAA,WACrB;AACL,cAAME,IAAkBT,IAAaA,EAAWQ,CAAK,IAAI,OAAOA,CAAK;AACrE,QAAAH,EAAgB,IAAIE,GAAKE,CAAe;AAAA,MAAA;AAAA,IAC1C,CACD;AAED,UAAMC,IAAQC,EAAkBN,GAAiBP,CAAI;AACrD,WAAIM,MAAU,aAAW,OAAO,QAAQ,aAAa,CAAA,GAAI,IAAIM,CAAK,GAC9DN,MAAU,UAAQ,OAAO,QAAQ,UAAU,CAAA,GAAI,IAAIM,CAAK,GAC5DE,EAAA,GAEOP;AAAA,EAAA,GAGHQ,IAA2B,CAACC,MAC5B,OAAOA,KAAiB,WACnBD,EAAyB,IAAI,gBAAgBC,CAAY,CAAC,IAG/DA,aAAwB,kBACnB,MAAM,KAAKA,EAAa,QAAA,CAAS,EAAE;AAAA,IACxC,CAACC,GAAK,CAACR,GAAKN,CAAK,OACfc,EAAIR,CAAG,IAAIL,EAAaD,CAAK,GACtBc;AAAA,IAET,CAAA;AAAA,EAAC,IAIED,GAGH,CAACb,GAAOe,CAAQ,IAAIC,EAAgB,MAAM;AAC9C,QAAI,OAAO,SAAW,IAAa,QAAQpB,KAAgB,CAAA;AAE3D,UAAMQ,IAAkBC,EAAmBR,CAAI,GACzCG,IAAQ;AAAA,MACZ,GAAIJ,KAAgBgB,EAAyBhB,CAAY;AAAA,MACzD,GAAGgB,EAAyBR,CAAe;AAAA,IAAA;AAG7C,WAAAF,EAAmBL,GAAMG,GAAOF,CAAS,GAElCE;AAAAA,EAAA,CACR,GAEKiB,IAAM,CAACvB,GAAwBC,MAA2C;AAC9E,UAAMkB,IAAeX;AAAA,MACnBL;AAAA,MACA,EAAE,GAAGG,GAAO,GAAGN,EAAAA;AAAAA,MACfC,GAAS,SAASG;AAAA,IAAA;AAEpB,IAAAiB,EAASH,EAAyBC,CAAY,CAAU;AAAA,EAAA;AAG1D,SAAAK,EAAU,MAAM;AACd,UAAMC,IAAiB,MAAM;AAC3B,YAAMN,IAAeR,EAAmBR,CAAI;AAC5C,MAAAkB,EAASH,EAAyBC,CAAY,CAAU;AAAA,IAAA;AAG1D,kBAAO,iBAAiBO,GAAyBD,CAAc,GAC/D,OAAO,iBAAiB,YAAYA,CAAc,GAC9CtB,MAAS,aAAW,OAAO,iBAAiB,cAAcsB,CAAc,GAErE,MAAM;AACX,aAAO,oBAAoBC,GAAyBD,CAAc,GAClE,OAAO,oBAAoB,YAAYA,CAAc,GACjDtB,MAAS,aAAW,OAAO,oBAAoB,cAAcsB,CAAc;AAAA,IAAA;AAAA,EACjF,GACC,CAACtB,CAAI,CAAC,GAEF;AAAA,IACL,OAAAG;AAAA,IACA,KAAAiB;AAAA,EAAA;AAEJ;"}

package/dist/esm/hooks/useVisibility/useVisibility.mjs

@@ -1,33 +1,41 @@
-import { useState as d, useRef as C, useEffect as E } from "react";
-import { useRefState as R } from "../useRefState/useRefState.mjs";
-import { isTarget as c } from "../../utils/helpers/isTarget.mjs";
-const V = (...e) => {
-  const n = c(e[0]) ? e[0] : void 0, t = n ? typeof e[1] == "object" ? e[1] : { onChange: e[1] } : typeof e[0] == "object" ? e[0] : { onChange: e[0] }, i = t?.onChange, f = t?.enabled ?? !0, [u, v] = d(), [o, y] = d(), r = R(), l = C(i);
-  return l.current = i, E(() => {
+import { useState as d, useRef as R, useEffect as C } from "react";
+import { useRefState as E } from "../useRefState/useRefState.mjs";
+import { isTarget as s } from "../../utils/helpers/isTarget.mjs";
+const S = ((...e) => {
+  const n = s(e[0]) ? e[0] : void 0, t = n ? typeof e[1] == "object" ? e[1] : { onChange: e[1] } : typeof e[0] == "object" ? e[0] : { onChange: e[0] }, i = t?.onChange, f = t?.enabled ?? !0, [u, v] = d(), [o, y] = d(), r = E(), l = R(i);
+  return l.current = i, C(() => {
     if (!f || !n && !r.state) return;
-    const b = n ? c.getElement(n) : r.current;
+    const b = n ? s.getElement(n) : r.current;
     if (!b) return;
-    const s = new IntersectionObserver(
-      (h, a) => {
-        const g = h.pop();
-        y(g), l.current?.(g, a);
+    const c = new IntersectionObserver(
+      (a, h) => {
+        const g = a.pop();
+        y(g), l.current?.(g, h);
       },
       {
         ...t,
-        root: t?.root ? c.getElement(t.root) : document
+        root: t?.root ? s.getElement(t.root) : document
       }
     );
-    return v(s), s.observe(b), () => {
-      s.disconnect();
+    return v(c), c.observe(b), () => {
+      c.disconnect();
     };
-  }, [n, r.state, t?.rootMargin, t?.threshold, t?.root, f]), n ? { observer: u, entry: o, inView: !!o?.isIntersecting } : {
+  }, [
+    n,
+    r.state,
+    s.getRefState(n),
+    t?.rootMargin,
+    t?.threshold,
+    t?.root,
+    f
+  ]), n ? { observer: u, entry: o, inView: !!o?.isIntersecting } : {
     observer: u,
     ref: r,
     entry: o,
     inView: !!o?.isIntersecting
   };
-};
+});
 export {
-  V as useVisibility
+  S as useVisibility
 };
 //# sourceMappingURL=useVisibility.mjs.map

package/dist/esm/hooks/useVisibility/useVisibility.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"useVisibility.mjs","sources":["../../../../src/hooks/useVisibility/useVisibility.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\n\nimport type { HookTarget } from '@/utils/helpers';\n\nimport { isTarget } from '@/utils/helpers';\n\nimport type { StateRef } from '../useRefState/useRefState';\n\nimport { useRefState } from '../useRefState/useRefState';\n\n/** The visibility callback type */\nexport type UseVisibilityCallback = (\n  entry: IntersectionObserverEntry,\n  observer: IntersectionObserver\n) => void;\n\n/** The visibility options type */\nexport interface UseVisibilityOptions extends Omit<IntersectionObserverInit, 'root'> {\n  /** The enabled state of the intersection */\n  enabled?: boolean;\n  /** The callback to execute when intersection is detected */\n  onChange?: UseVisibilityCallback;\n  /** The root element to observe */\n  root?: HookTarget;\n}\n\n/** The intersection observer return type */\nexport interface UseVisibilityReturn {\n  /** The intersection observer entry */\n  entry?: IntersectionObserverEntry;\n  /** The intersection observer in view */\n  inView?: boolean;\n\n  /** The intersection observer instance */\n  observer?: IntersectionObserver;\n}\n\nexport interface UseVisibility {\n  <Target extends Element>(\n    options?: UseVisibilityOptions,\n    target?: never\n  ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n  (target: HookTarget, options?: UseVisibilityOptions): UseVisibilityReturn;\n\n  <Target extends Element>(\n    callback: UseVisibilityCallback,\n    target?: never\n  ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n  (target: HookTarget, callback: UseVisibilityCallback): UseVisibilityReturn;\n}\n\n/**\n * @name useVisibility\n * @description - Hook that gives you visibility observer state\n * @category Sensors\n * @usage medium\n *\n * @browserapi IntersectionObserver https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver\n *\n * @overload\n * @param {HookTarget} target The target element to detect intersection\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { ref, entries, observer } = useVisibility();\n *\n * @overload\n * @template Target The target element\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { entries, observer } = useVisibility(ref);\n *\n * @overload\n * @template Target The target element\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { ref, entries, observer } = useVisibility(() => console.log('callback'));\n *\n * @overload\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @param {HookTarget} target The target element to detect intersection\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { entries, observer } = useVisibility(ref, () => console.log('callback'));\n */\nexport const useVisibility = ((...params: any[]) => {\n  const target = (isTarget(params[0]) ? params[0] : undefined) as HookTarget | undefined;\n\n  const options = (\n    target\n      ? typeof params[1] === 'object'\n        ? params[1]\n        : { onChange: params[1] }\n      : typeof params[0] === 'object'\n        ? params[0]\n        : { onChange: params[0] }\n  ) as UseVisibilityOptions | undefined;\n\n  const callback = options?.onChange;\n  const enabled = options?.enabled ?? true;\n\n  const [observer, setObserver] = useState<IntersectionObserver>();\n  const [entry, setEntry] = useState<IntersectionObserverEntry>();\n\n  const internalRef = useRefState<Element>();\n  const internalCallbackRef = useRef(callback);\n  internalCallbackRef.current = callback;\n\n  useEffect(() => {\n    if (!enabled || (!target && !internalRef.state)) return;\n\n    const element = target ? isTarget.getElement(target) : internalRef.current;\n    if (!element) return;\n\n    const observer = new IntersectionObserver(\n      (entries: IntersectionObserverEntry[], observer: IntersectionObserver) => {\n        const entry = entries.pop()!;\n        setEntry(entry);\n        internalCallbackRef.current?.(entry, observer);\n      },\n      {\n        ...options,\n        root: options?.root ? (isTarget.getElement(options.root) as Document | Element) : document\n      }\n    );\n\n    setObserver(observer);\n    observer.observe(element as Element);\n\n    return () => {\n      observer.disconnect();\n    };\n  }, [target, internalRef.state, options?.rootMargin, options?.threshold, options?.root, enabled]);\n\n  if (target) return { observer, entry, inView: !!entry?.isIntersecting };\n  return {\n    observer,\n    ref: internalRef,\n    entry,\n    inView: !!entry?.isIntersecting\n  };\n}) as UseVisibility;\n"],"names":["useVisibility","params","target","isTarget","options","callback","enabled","observer","setObserver","useState","entry","setEntry","internalRef","useRefState","internalCallbackRef","useRef","useEffect","element","entries"],"mappings":";;;AAiGO,MAAMA,IAAiB,IAAIC,MAAkB;AAClD,QAAMC,IAAUC,EAASF,EAAO,CAAC,CAAC,IAAIA,EAAO,CAAC,IAAI,QAE5CG,IACJF,IACI,OAAOD,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,IACtB,OAAOA,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,GAGtBI,IAAWD,GAAS,UACpBE,IAAUF,GAAS,WAAW,IAE9B,CAACG,GAAUC,CAAW,IAAIC,EAAA,GAC1B,CAACC,GAAOC,CAAQ,IAAIF,EAAA,GAEpBG,IAAcC,EAAA,GACdC,IAAsBC,EAAOV,CAAQ;AA6B3C,SA5BAS,EAAoB,UAAUT,GAE9BW,EAAU,MAAM;AACd,QAAI,CAACV,KAAY,CAACJ,KAAU,CAACU,EAAY,MAAQ;AAEjD,UAAMK,IAAUf,IAASC,EAAS,WAAWD,CAAM,IAAIU,EAAY;AACnE,QAAI,CAACK,EAAS;AAEd,UAAMV,IAAW,IAAI;AAAA,MACnB,CAACW,GAAsCX,MAAmC;AACxE,cAAMG,IAAQQ,EAAQ,IAAA;AACtB,QAAAP,EAASD,CAAK,GACdI,EAAoB,UAAUJ,GAAOH,CAAQ;AAAA,MAAA;AAAA,MAE/C;AAAA,QACE,GAAGH;AAAA,QACH,MAAMA,GAAS,OAAQD,EAAS,WAAWC,EAAQ,IAAI,IAA2B;AAAA,MAAA;AAAA,IACpF;AAGF,WAAAI,EAAYD,CAAQ,GACpBA,EAAS,QAAQU,CAAkB,GAE5B,MAAM;AACXV,MAAAA,EAAS,WAAA;AAAA,IAAW;AAAA,EACtB,GACC,CAACL,GAAQU,EAAY,OAAOR,GAAS,YAAYA,GAAS,WAAWA,GAAS,MAAME,CAAO,CAAC,GAE3FJ,IAAe,EAAE,UAAAK,GAAU,OAAAG,GAAO,QAAQ,CAAC,CAACA,GAAO,eAAA,IAChD;AAAA,IACL,UAAAH;AAAA,IACA,KAAKK;AAAA,IACL,OAAAF;AAAA,IACA,QAAQ,CAAC,CAACA,GAAO;AAAA,EAAA;AAErB;"}
+{"version":3,"file":"useVisibility.mjs","sources":["../../../../src/hooks/useVisibility/useVisibility.ts"],"sourcesContent":["import { useEffect, useRef, useState } from 'react';\n\nimport type { HookTarget } from '@/utils/helpers';\n\nimport { isTarget } from '@/utils/helpers';\n\nimport type { StateRef } from '../useRefState/useRefState';\n\nimport { useRefState } from '../useRefState/useRefState';\n\n/** The visibility callback type */\nexport type UseVisibilityCallback = (\n  entry: IntersectionObserverEntry,\n  observer: IntersectionObserver\n) => void;\n\n/** The visibility options type */\nexport interface UseVisibilityOptions extends Omit<IntersectionObserverInit, 'root'> {\n  /** The enabled state of the intersection */\n  enabled?: boolean;\n  /** The callback to execute when intersection is detected */\n  onChange?: UseVisibilityCallback;\n  /** The root element to observe */\n  root?: HookTarget;\n}\n\n/** The intersection observer return type */\nexport interface UseVisibilityReturn {\n  /** The intersection observer entry */\n  entry?: IntersectionObserverEntry;\n  /** The intersection observer in view */\n  inView?: boolean;\n\n  /** The intersection observer instance */\n  observer?: IntersectionObserver;\n}\n\nexport interface UseVisibility {\n  <Target extends Element>(\n    options?: UseVisibilityOptions,\n    target?: never\n  ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n  (target: HookTarget, options?: UseVisibilityOptions): UseVisibilityReturn;\n\n  <Target extends Element>(\n    callback: UseVisibilityCallback,\n    target?: never\n  ): UseVisibilityReturn & { ref: StateRef<Target> };\n\n  (target: HookTarget, callback: UseVisibilityCallback): UseVisibilityReturn;\n}\n\n/**\n * @name useVisibility\n * @description - Hook that gives you visibility observer state\n * @category Sensors\n * @usage medium\n *\n * @browserapi IntersectionObserver https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver\n *\n * @overload\n * @param {HookTarget} target The target element to detect intersection\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { ref, entries, observer } = useVisibility();\n *\n * @overload\n * @template Target The target element\n * @param {boolean} [options.enabled=true] The Intersection options\n * @param {((entries: IntersectionEntry[], observer: Intersection) => void) | undefined} [options.onChange] The callback to execute when intersection is detected\n * @param {HookTarget} [options.root=document] The root element to observe\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { entries, observer } = useVisibility(ref);\n *\n * @overload\n * @template Target The target element\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @returns {UseVisibilityReturn & { ref: StateRef<Target> }} A React ref to attach to the target element\n *\n * @example\n * const { ref, entries, observer } = useVisibility(() => console.log('callback'));\n *\n * @overload\n * @param {UseVisibilityCallback} callback The callback to execute when intersection is detected\n * @param {HookTarget} target The target element to detect intersection\n * @returns {UseVisibilityReturn} An object containing the state\n *\n * @example\n * const { entries, observer } = useVisibility(ref, () => console.log('callback'));\n */\nexport const useVisibility = ((...params: any[]) => {\n  const target = (isTarget(params[0]) ? params[0] : undefined) as HookTarget | undefined;\n\n  const options = (\n    target\n      ? typeof params[1] === 'object'\n        ? params[1]\n        : { onChange: params[1] }\n      : typeof params[0] === 'object'\n        ? params[0]\n        : { onChange: params[0] }\n  ) as UseVisibilityOptions | undefined;\n\n  const callback = options?.onChange;\n  const enabled = options?.enabled ?? true;\n\n  const [observer, setObserver] = useState<IntersectionObserver>();\n  const [entry, setEntry] = useState<IntersectionObserverEntry>();\n\n  const internalRef = useRefState<Element>();\n  const internalCallbackRef = useRef(callback);\n  internalCallbackRef.current = callback;\n\n  useEffect(() => {\n    if (!enabled || (!target && !internalRef.state)) return;\n\n    const element = target ? isTarget.getElement(target) : internalRef.current;\n    if (!element) return;\n\n    const observer = new IntersectionObserver(\n      (entries: IntersectionObserverEntry[], observer: IntersectionObserver) => {\n        const entry = entries.pop()!;\n        setEntry(entry);\n        internalCallbackRef.current?.(entry, observer);\n      },\n      {\n        ...options,\n        root: options?.root ? (isTarget.getElement(options.root) as Document | Element) : document\n      }\n    );\n\n    setObserver(observer);\n    observer.observe(element as Element);\n\n    return () => {\n      observer.disconnect();\n    };\n  }, [\n    target,\n    internalRef.state,\n    isTarget.getRefState(target),\n    options?.rootMargin,\n    options?.threshold,\n    options?.root,\n    enabled\n  ]);\n\n  if (target) return { observer, entry, inView: !!entry?.isIntersecting };\n  return {\n    observer,\n    ref: internalRef,\n    entry,\n    inView: !!entry?.isIntersecting\n  };\n}) as UseVisibility;\n"],"names":["useVisibility","params","target","isTarget","options","callback","enabled","observer","setObserver","useState","entry","setEntry","internalRef","useRefState","internalCallbackRef","useRef","useEffect","element","entries"],"mappings":";;;AAiGO,MAAMA,KAAiB,IAAIC,MAAkB;AAClD,QAAMC,IAAUC,EAASF,EAAO,CAAC,CAAC,IAAIA,EAAO,CAAC,IAAI,QAE5CG,IACJF,IACI,OAAOD,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,IACtB,OAAOA,EAAO,CAAC,KAAM,WACnBA,EAAO,CAAC,IACR,EAAE,UAAUA,EAAO,CAAC,EAAA,GAGtBI,IAAWD,GAAS,UACpBE,IAAUF,GAAS,WAAW,IAE9B,CAACG,GAAUC,CAAW,IAAIC,EAAA,GAC1B,CAACC,GAAOC,CAAQ,IAAIF,EAAA,GAEpBG,IAAcC,EAAA,GACdC,IAAsBC,EAAOV,CAAQ;AAqC3C,SApCAS,EAAoB,UAAUT,GAE9BW,EAAU,MAAM;AACd,QAAI,CAACV,KAAY,CAACJ,KAAU,CAACU,EAAY,MAAQ;AAEjD,UAAMK,IAAUf,IAASC,EAAS,WAAWD,CAAM,IAAIU,EAAY;AACnE,QAAI,CAACK,EAAS;AAEd,UAAMV,IAAW,IAAI;AAAA,MACnB,CAACW,GAAsCX,MAAmC;AACxE,cAAMG,IAAQQ,EAAQ,IAAA;AACtB,QAAAP,EAASD,CAAK,GACdI,EAAoB,UAAUJ,GAAOH,CAAQ;AAAA,MAAA;AAAA,MAE/C;AAAA,QACE,GAAGH;AAAA,QACH,MAAMA,GAAS,OAAQD,EAAS,WAAWC,EAAQ,IAAI,IAA2B;AAAA,MAAA;AAAA,IACpF;AAGF,WAAAI,EAAYD,CAAQ,GACpBA,EAAS,QAAQU,CAAkB,GAE5B,MAAM;AACXV,MAAAA,EAAS,WAAA;AAAA,IAAW;AAAA,EACtB,GACC;AAAA,IACDL;AAAA,IACAU,EAAY;AAAA,IACZT,EAAS,YAAYD,CAAM;AAAA,IAC3BE,GAAS;AAAA,IACTA,GAAS;AAAA,IACTA,GAAS;AAAA,IACTE;AAAA,EAAA,CACD,GAEGJ,IAAe,EAAE,UAAAK,GAAU,OAAAG,GAAO,QAAQ,CAAC,CAACA,GAAO,eAAA,IAChD;AAAA,IACL,UAAAH;AAAA,IACA,KAAKK;AAAA,IACL,OAAAF;AAAA,IACA,QAAQ,CAAC,CAACA,GAAO;AAAA,EAAA;AAErB;"}

package/dist/esm/index.mjs

@@ -7,7 +7,7 @@ import { useLockCallback as n } from "./hooks/useLockCallback/useLockCallback.mj
 import { useMutation as l } from "./hooks/useMutation/useMutation.mjs";
 import { useOptimistic as E } from "./hooks/useOptimistic/useOptimistic.mjs";
 import { useQuery as g } from "./hooks/useQuery/useQuery.mjs";
-import { useAudio as R } from "./hooks/useAudio/useAudio.mjs";
+import { useAudio as d } from "./hooks/useAudio/useAudio.mjs";
 import { useBattery as P } from "./hooks/useBattery/useBattery.mjs";
 import { useBluetooth as I } from "./hooks/useBluetooth/useBluetooth.mjs";
 import { useBroadcastChannel as O } from "./hooks/useBroadcastChannel/useBroadcastChannel.mjs";
@@ -32,7 +32,7 @@ import { usePermission as ie } from "./hooks/usePermission/usePermission.mjs";
 import { usePictureInPicture as ce } from "./hooks/usePictureInPicture/usePictureInPicture.mjs";
 import { usePointerLock as Se } from "./hooks/usePointerLock/usePointerLock.mjs";
 import { usePostMessage as Te } from "./hooks/usePostMessage/usePostMessage.mjs";
-import { useRaf as de } from "./hooks/useRaf/useRaf.mjs";
+import { useRaf as Re } from "./hooks/useRaf/useRaf.mjs";
 import { useShare as Ce } from "./hooks/useShare/useShare.mjs";
 import { getSpeechRecognition as Ae, useSpeechRecognition as Ie } from "./hooks/useSpeechRecognition/useSpeechRecognition.mjs";
 import { useSpeechSynthesis as Oe } from "./hooks/useSpeechSynthesis/useSpeechSynthesis.mjs";
@@ -78,7 +78,7 @@ import { useDevicePixelRatio as nr } from "./hooks/useDevicePixelRatio/useDevice
 import { useDocumentEvent as lr } from "./hooks/useDocumentEvent/useDocumentEvent.mjs";
 import { useDocumentVisibility as Er } from "./hooks/useDocumentVisibility/useDocumentVisibility.mjs";
 import { useElementSize as gr } from "./hooks/useElementSize/useElementSize.mjs";
-import { useEventListener as Rr } from "./hooks/useEventListener/useEventListener.mjs";
+import { useEventListener as dr } from "./hooks/useEventListener/useEventListener.mjs";
 import { isHotkeyMatch as Pr, useHotkeys as Ar } from "./hooks/useHotkeys/useHotkeys.mjs";
 import { useIdle as yr } from "./hooks/useIdle/useIdle.mjs";
 import { useInfiniteScroll as kr } from "./hooks/useInfiniteScroll/useInfiniteScroll.mjs";
@@ -104,7 +104,7 @@ import { getRangesSelection as it, useTextSelection as nt } from "./hooks/useTex
 import { useVisibility as lt } from "./hooks/useVisibility/useVisibility.mjs";
 import { useWindowEvent as Et } from "./hooks/useWindowEvent/useWindowEvent.mjs";
 import { useWindowFocus as gt } from "./hooks/useWindowFocus/useWindowFocus.mjs";
-import { scrollTo as Rt, useWindowScroll as Ct } from "./hooks/useWindowScroll/useWindowScroll.mjs";
+import { scrollTo as dt, useWindowScroll as Ct } from "./hooks/useWindowScroll/useWindowScroll.mjs";
 import { useWindowSize as At } from "./hooks/useWindowSize/useWindowSize.mjs";
 import { useBoolean as yt } from "./hooks/useBoolean/useBoolean.mjs";
 import { useControllableState as kt } from "./hooks/useControllableState/useControllableState.mjs";
@@ -122,45 +122,45 @@ import { assignRef as us, mergeRefs as ms, useMergedRef as ps } from "./hooks/us
 import { useOffsetPagination as xs } from "./hooks/useOffsetPagination/useOffsetPagination.mjs";
 import { useQueue as is } from "./hooks/useQueue/useQueue.mjs";
 import { useRafState as cs } from "./hooks/useRafState/useRafState.mjs";
-import { useRefState as Ss } from "./hooks/useRefState/useRefState.mjs";
-import { useSessionStorage as Ts } from "./hooks/useSessionStorage/useSessionStorage.mjs";
+import { createRefState as Ss, useRefState as Es } from "./hooks/useRefState/useRefState.mjs";
+import { useSessionStorage as gs } from "./hooks/useSessionStorage/useSessionStorage.mjs";
 import { useSet as ds } from "./hooks/useSet/useSet.mjs";
-import { stateHistoryReducer as Cs, useStateHistory as Ps } from "./hooks/useStateHistory/useStateHistory.mjs";
-import { useStep as Is } from "./hooks/useStep/useStep.mjs";
-import { STORAGE_EVENT as Os, dispatchStorageEvent as ks, useStorage as hs } from "./hooks/useStorage/useStorage.mjs";
-import { useToggle as _s } from "./hooks/useToggle/useToggle.mjs";
-import { URL_SEARCH_PARAMS_EVENT as bs, createQueryString as Ls, dispatchUrlSearchParamsEvent as Ms, getUrlSearchParams as Ns, useUrlSearchParam as Bs } from "./hooks/useUrlSearchParam/useUrlSearchParam.mjs";
-import { useUrlSearchParams as Fs } from "./hooks/useUrlSearchParams/useUrlSearchParams.mjs";
-import { useWizard as Vs } from "./hooks/useWizard/useWizard.mjs";
-import { useInterval as ws } from "./hooks/useInterval/useInterval.mjs";
-import { useStopwatch as zs } from "./hooks/useStopwatch/useStopwatch.mjs";
-import { useTime as Qs } from "./hooks/useTime/useTime.mjs";
-import { useTimeout as qs } from "./hooks/useTimeout/useTimeout.mjs";
-import { getTimeFromSeconds as js, useTimer as Js } from "./hooks/useTimer/useTimer.mjs";
-import { useBrowserLanguage as $s } from "./hooks/useBrowserLanguage/useBrowserLanguage.mjs";
-import { getOperatingSystem as ou, useOperatingSystem as ru } from "./hooks/useOperatingSystem/useOperatingSystem.mjs";
-import { usePreferredColorScheme as su } from "./hooks/usePreferredColorScheme/usePreferredColorScheme.mjs";
-import { usePreferredContrast as mu } from "./hooks/usePreferredContrast/usePreferredContrast.mjs";
-import { usePreferredDark as fu } from "./hooks/usePreferredDark/usePreferredDark.mjs";
-import { usePreferredLanguages as au } from "./hooks/usePreferredLanguages/usePreferredLanguages.mjs";
-import { usePreferredReducedMotion as nu } from "./hooks/usePreferredReducedMotion/usePreferredReducedMotion.mjs";
-import { useConst as lu } from "./hooks/useConst/useConst.mjs";
-import { useDebounceCallback as Eu } from "./hooks/useDebounceCallback/useDebounceCallback.mjs";
-import { useDebounceState as gu } from "./hooks/useDebounceState/useDebounceState.mjs";
-import { useDebounceValue as Ru } from "./hooks/useDebounceValue/useDebounceValue.mjs";
-import { useEvent as Pu } from "./hooks/useEvent/useEvent.mjs";
-import { useLastChanged as Iu } from "./hooks/useLastChanged/useLastChanged.mjs";
-import { useLatest as Ou } from "./hooks/useLatest/useLatest.mjs";
-import { usePrevious as hu } from "./hooks/usePrevious/usePrevious.mjs";
-import { useThrottleCallback as _u } from "./hooks/useThrottleCallback/useThrottleCallback.mjs";
-import { useThrottleState as bu } from "./hooks/useThrottleState/useThrottleState.mjs";
-import { useThrottleValue as Mu } from "./hooks/useThrottleValue/useThrottleValue.mjs";
-import { copy as Bu, legacyCopyToClipboard as Ku } from "./utils/helpers/copy.mjs";
-import { debounce as Uu } from "./utils/helpers/debounce.mjs";
-import { getDate as Hu } from "./utils/helpers/getDate.mjs";
-import { getRetry as Wu } from "./utils/helpers/getRetry.mjs";
-import { isTarget as Gu, target as Qu, targetSymbol as Xu } from "./utils/helpers/isTarget.mjs";
-import { throttle as Zu } from "./utils/helpers/throttle.mjs";
+import { stateHistoryReducer as Ps, useStateHistory as As } from "./hooks/useStateHistory/useStateHistory.mjs";
+import { useStep as ys } from "./hooks/useStep/useStep.mjs";
+import { STORAGE_EVENT as ks, dispatchStorageEvent as hs, useStorage as vs } from "./hooks/useStorage/useStorage.mjs";
+import { useToggle as Ds } from "./hooks/useToggle/useToggle.mjs";
+import { URL_SEARCH_PARAMS_EVENT as Ls, createQueryString as Ms, dispatchUrlSearchParamsEvent as Ns, getUrlSearchParams as Bs, useUrlSearchParam as Ks } from "./hooks/useUrlSearchParam/useUrlSearchParam.mjs";
+import { useUrlSearchParams as Us } from "./hooks/useUrlSearchParams/useUrlSearchParams.mjs";
+import { useWizard as Hs } from "./hooks/useWizard/useWizard.mjs";
+import { useInterval as Ws } from "./hooks/useInterval/useInterval.mjs";
+import { useStopwatch as Gs } from "./hooks/useStopwatch/useStopwatch.mjs";
+import { useTime as Xs } from "./hooks/useTime/useTime.mjs";
+import { useTimeout as Zs } from "./hooks/useTimeout/useTimeout.mjs";
+import { getTimeFromSeconds as Js, useTimer as Ys } from "./hooks/useTimer/useTimer.mjs";
+import { useBrowserLanguage as eu } from "./hooks/useBrowserLanguage/useBrowserLanguage.mjs";
+import { getOperatingSystem as ru, useOperatingSystem as tu } from "./hooks/useOperatingSystem/useOperatingSystem.mjs";
+import { usePreferredColorScheme as uu } from "./hooks/usePreferredColorScheme/usePreferredColorScheme.mjs";
+import { usePreferredContrast as pu } from "./hooks/usePreferredContrast/usePreferredContrast.mjs";
+import { usePreferredDark as xu } from "./hooks/usePreferredDark/usePreferredDark.mjs";
+import { usePreferredLanguages as iu } from "./hooks/usePreferredLanguages/usePreferredLanguages.mjs";
+import { usePreferredReducedMotion as cu } from "./hooks/usePreferredReducedMotion/usePreferredReducedMotion.mjs";
+import { useConst as Su } from "./hooks/useConst/useConst.mjs";
+import { useDebounceCallback as Tu } from "./hooks/useDebounceCallback/useDebounceCallback.mjs";
+import { useDebounceState as Ru } from "./hooks/useDebounceState/useDebounceState.mjs";
+import { useDebounceValue as Cu } from "./hooks/useDebounceValue/useDebounceValue.mjs";
+import { useEvent as Au } from "./hooks/useEvent/useEvent.mjs";
+import { useLastChanged as yu } from "./hooks/useLastChanged/useLastChanged.mjs";
+import { useLatest as ku } from "./hooks/useLatest/useLatest.mjs";
+import { usePrevious as vu } from "./hooks/usePrevious/usePrevious.mjs";
+import { useThrottleCallback as Du } from "./hooks/useThrottleCallback/useThrottleCallback.mjs";
+import { useThrottleState as Lu } from "./hooks/useThrottleState/useThrottleState.mjs";
+import { useThrottleValue as Nu } from "./hooks/useThrottleValue/useThrottleValue.mjs";
+import { copy as Ku, legacyCopyToClipboard as Fu } from "./utils/helpers/copy.mjs";
+import { debounce as Vu } from "./utils/helpers/debounce.mjs";
+import { getDate as wu } from "./utils/helpers/getDate.mjs";
+import { getRetry as zu } from "./utils/helpers/getRetry.mjs";
+import { getRefState as Qu, isTarget as Xu, target as qu, targetSymbol as Zu } from "./utils/helpers/isTarget.mjs";
+import { throttle as Ju } from "./utils/helpers/throttle.mjs";
 export {
   Jo as BREAKPOINTS_ANT_DESIGN,
   Yo as BREAKPOINTS_BOOTSTRAP_V5,
@@ -177,70 +177,72 @@ export {
   lo as Paint,
   So as Pointer,
   Co as SCRIPT_STATUS_ATTRIBUTE_NAME,
-  Os as STORAGE_EVENT,
-  bs as URL_SEARCH_PARAMS_EVENT,
+  ks as STORAGE_EVENT,
+  Ls as URL_SEARCH_PARAMS_EVENT,
   us as assignRef,
   Ut as clearCookies,
-  Bu as copy,
+  Ku as copy,
   r as createContext,
   s as createEventEmitter,
-  Ls as createQueryString,
+  Ms as createQueryString,
   m as createReactiveContext,
+  Ss as createRefState,
   f as createStore,
-  Uu as debounce,
+  Vu as debounce,
   Qo as deepEqual,
   _t as dispatchCookieEvent,
-  ks as dispatchStorageEvent,
-  Ms as dispatchUrlSearchParamsEvent,
+  hs as dispatchStorageEvent,
+  Ns as dispatchUrlSearchParamsEvent,
   se as getConnection,
   Dt as getCookie,
   bt as getCookies,
-  Hu as getDate,
+  wu as getDate,
   jt as getHash,
-  ou as getOperatingSystem,
+  ru as getOperatingSystem,
   it as getRangesSelection,
-  Wu as getRetry,
+  Qu as getRefState,
+  zu as getRetry,
   Ae as getSpeechRecognition,
-  js as getTimeFromSeconds,
-  Ns as getUrlSearchParams,
+  Js as getTimeFromSeconds,
+  Bs as getUrlSearchParams,
   Pr as isHotkeyMatch,
-  Gu as isTarget,
-  Ku as legacyCopyToClipboard,
+  Xu as isTarget,
+  Fu as legacyCopyToClipboard,
   q as mapGamepadToXbox360Controller,
   ms as mergeRefs,
   Lt as removeCookie,
   Mt as removeCookieItem,
-  Rt as scrollTo,
+  dt as scrollTo,
   Nt as setCookie,
   Bt as setCookieItem,
-  Cs as stateHistoryReducer,
-  Qu as target,
-  Xu as targetSymbol,
-  Zu as throttle,
+  Ps as stateHistoryReducer,
+  qu as target,
+  Zu as targetSymbol,
+  Ju as throttle,
   $ as timeRangeToArray,
   ze as useActiveElement,
   a as useAsync,
   Bo as useAsyncEffect,
-  R as useAudio,
+  d as useAudio,
   Qe as useAutoScroll,
   P as useBattery,
   I as useBluetooth,
   yt as useBoolean,
   mr as useBreakpoints,
   O as useBroadcastChannel,
-  $s as useBrowserLanguage,
+  eu as useBrowserLanguage,
   qe as useClickOutside,
   h as useClipboard,
-  lu as useConst,
+  Su as useConst,
   kt as useControllableState,
   Kt as useCookie,
   Vt as useCookies,
   _ as useCopy,
   wt as useCounter,
   b as useCssVar,
-  Eu as useDebounceCallback,
-  gu as useDebounceState,
-  Ru as useDebounceValue,
+  Tu as useDebounceCallback,
+  Ru as useDebounceState,
+  Cu as useDebounceValue,
   zt as useDefault,
   fr as useDeviceMotion,
   ar as useDeviceOrientation,
@@ -254,8 +256,8 @@ export {
   Je as useDoubleClick,
   $e as useDropZone,
   gr as useElementSize,
-  Pu as useEvent,
-  Rr as useEventListener,
+  Au as useEvent,
+  dr as useEventListener,
   F as useEventSource,
   V as useEyeDropper,
   w as useFavicon,
@@ -275,15 +277,15 @@ export {
   ao as useImage,
   kr as useInfiniteScroll,
   vr as useIntersectionObserver,
-  ws as useInterval,
+  Ws as useInterval,
   Vo as useIsFirstRender,
   wo as useIsomorphicLayoutEffect,
   Lr as useKeyPress,
   Nr as useKeyPressEvent,
   Dr as useKeyboard,
   Kr as useKeysPressed,
-  Iu as useLastChanged,
-  Ou as useLatest,
+  yu as useLastChanged,
+  ku as useLatest,
   bo as useLess,
   $t as useList,
   os as useLocalStorage,
@@ -305,7 +307,7 @@ export {
   xs as useOffsetPagination,
   Mo as useOnce,
   pe as useOnline,
-  ru as useOperatingSystem,
+  tu as useOperatingSystem,
   E as useOptimistic,
   Zr as useOrientation,
   xe as useOtpCredential,
@@ -317,17 +319,17 @@ export {
   ce as usePictureInPicture,
   Se as usePointerLock,
   Te as usePostMessage,
-  su as usePreferredColorScheme,
-  mu as usePreferredContrast,
-  fu as usePreferredDark,
-  au as usePreferredLanguages,
-  nu as usePreferredReducedMotion,
-  hu as usePrevious,
+  uu as usePreferredColorScheme,
+  pu as usePreferredContrast,
+  xu as usePreferredDark,
+  iu as usePreferredLanguages,
+  cu as usePreferredReducedMotion,
+  vu as usePrevious,
   g as useQuery,
   is as useQueue,
-  de as useRaf,
+  Re as useRaf,
   cs as useRafState,
-  Ss as useRefState,
+  Es as useRefState,
   Fe as useRenderCount,
   Ve as useRenderInfo,
   we as useRerender,
@@ -337,30 +339,30 @@ export {
   ut as useScroll,
   pt as useScrollIntoView,
   xt as useScrollTo,
-  Ts as useSessionStorage,
+  gs as useSessionStorage,
   ds as useSet,
   Xo as useShallowEffect,
   Ce as useShare,
   Ie as useSpeechRecognition,
   Oe as useSpeechSynthesis,
-  Ps as useStateHistory,
-  Is as useStep,
+  As as useStateHistory,
+  ys as useStep,
   Io as useSticky,
-  zs as useStopwatch,
-  hs as useStorage,
+  Gs as useStopwatch,
+  vs as useStorage,
   ho as useTextDirection,
   nt as useTextSelection,
   Oo as useTextareaAutosize,
-  _u as useThrottleCallback,
-  bu as useThrottleState,
-  Mu as useThrottleValue,
-  Qs as useTime,
-  qs as useTimeout,
-  Js as useTimer,
-  _s as useToggle,
+  Du as useThrottleCallback,
+  Lu as useThrottleState,
+  Nu as useThrottleValue,
+  Xs as useTime,
+  Zs as useTimeout,
+  Ys as useTimer,
+  Ds as useToggle,
   Zo as useUnmount,
-  Bs as useUrlSearchParam,
-  Fs as useUrlSearchParams,
+  Ks as useUrlSearchParam,
+  Us as useUrlSearchParams,
   he as useVibrate,
   _e as useVirtualKeyboard,
   lt as useVisibility,
@@ -370,6 +372,6 @@ export {
   gt as useWindowFocus,
   Ct as useWindowScroll,
   At as useWindowSize,
-  Vs as useWizard
+  Hs as useWizard
 };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/utils/helpers/isTarget.mjs

@@ -1,12 +1,14 @@
-const n = Symbol("target"), o = (e) => "current" in e ? e.current : typeof e.value == "function" ? e.value() : typeof e.value == "string" ? document.querySelector(e.value) : (e.value instanceof Document || e.value instanceof Window || e.value instanceof Element, e.value), l = (e) => ({
+const u = /* @__PURE__ */ Symbol("target"), o = (e) => "current" in e ? e.current : typeof e.value == "function" ? e.value() : typeof e.value == "string" ? document.querySelector(e.value) : (e.value instanceof Document || e.value instanceof Window || e.value instanceof Element, e.value), i = (e) => ({
   value: e,
-  type: n
-}), u = (e) => typeof e == "object" && ("current" in e || e && e.type === n);
-u.wrap = l;
-u.getElement = o;
+  type: u
+}), n = (e) => typeof e == "object" && ("current" in e || e && e.type === u) || typeof e == "function" && "state" in e && "current" in e, c = (e) => e && "state" in e && e.state;
+n.wrap = i;
+n.getElement = o;
+n.getRefState = c;
 export {
-  u as isTarget,
-  l as target,
-  n as targetSymbol
+  c as getRefState,
+  n as isTarget,
+  i as target,
+  u as targetSymbol
 };
 //# sourceMappingURL=isTarget.mjs.map

package/dist/esm/utils/helpers/isTarget.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"isTarget.mjs","sources":["../../../../src/utils/helpers/isTarget.ts"],"sourcesContent":["import type { RefObject } from 'react';\n\nexport const targetSymbol = Symbol('target');\n\nexport type Target = (() => Element) | string | Document | Element | Window;\n\nexport type HookTarget =\n  | RefObject<Element | null | undefined>\n  | {\n      value: Target;\n      type: symbol;\n    };\n\nconst getElement = (target: HookTarget) => {\n  if ('current' in target) {\n    return target.current;\n  }\n\n  if (typeof target.value === 'function') {\n    return target.value();\n  }\n\n  if (typeof target.value === 'string') {\n    return document.querySelector(target.value);\n  }\n\n  if (target.value instanceof Document) {\n    return target.value;\n  }\n\n  if (target.value instanceof Window) {\n    return target.value;\n  }\n\n  if (target.value instanceof Element) {\n    return target.value;\n  }\n\n  return target.value;\n};\n\nexport const target = (target: Target) => ({\n  value: target,\n  type: targetSymbol\n});\n\nexport const isTarget = (target: HookTarget) =>\n  typeof target === 'object' &&\n  ('current' in target || (target && (target as any).type === targetSymbol));\n\nisTarget.wrap = target;\nisTarget.getElement = getElement;\n"],"names":["targetSymbol","getElement","target","isTarget"],"mappings":"AAEO,MAAMA,IAAe,OAAO,QAAQ,GAWrCC,IAAa,CAACC,MACd,aAAaA,IACRA,EAAO,UAGZ,OAAOA,EAAO,SAAU,aACnBA,EAAO,MAAA,IAGZ,OAAOA,EAAO,SAAU,WACnB,SAAS,cAAcA,EAAO,KAAK,KAGxCA,EAAO,iBAAiB,YAIxBA,EAAO,iBAAiB,UAIxBA,EAAO,iBAAiB,SACnBA,EAAO,QAMLA,IAAS,CAACA,OAAoB;AAAA,EACzC,OAAOA;AAAAA,EACP,MAAMF;AACR,IAEaG,IAAW,CAACD,MACvB,OAAOA,KAAW,aACjB,aAAaA,KAAWA,KAAWA,EAAe,SAASF;AAE9DG,EAAS,OAAOD;AAChBC,EAAS,aAAaF;"}
+{"version":3,"file":"isTarget.mjs","sources":["../../../../src/utils/helpers/isTarget.ts"],"sourcesContent":["import type { RefObject } from 'react';\n\nexport const targetSymbol = Symbol('target');\n\nexport type Target = (() => Element) | string | Document | Element | Window;\ninterface StateRef<Value> {\n  (node: Value): void;\n  current: Value;\n  state: Value;\n}\n\nexport type HookTarget =\n  | RefObject<Element | null | undefined>\n  | StateRef<Element | null | undefined>\n  | {\n      value: Target;\n      type: symbol;\n    };\n\nconst getElement = (target: HookTarget) => {\n  if ('current' in target) {\n    return target.current;\n  }\n\n  if (typeof target.value === 'function') {\n    return target.value();\n  }\n\n  if (typeof target.value === 'string') {\n    return document.querySelector(target.value);\n  }\n\n  if (target.value instanceof Document) {\n    return target.value;\n  }\n\n  if (target.value instanceof Window) {\n    return target.value;\n  }\n\n  if (target.value instanceof Element) {\n    return target.value;\n  }\n\n  return target.value;\n};\n\nexport const target = (target: Target) => ({\n  value: target,\n  type: targetSymbol\n});\n\nexport const isTarget = (target: HookTarget) =>\n  (typeof target === 'object' &&\n    ('current' in target || (target && (target as any).type === targetSymbol))) ||\n  (typeof target === 'function' && 'state' in target && 'current' in target);\n\nexport const getRefState = (target?: HookTarget) => target && 'state' in target && target.state;\n\nisTarget.wrap = target;\nisTarget.getElement = getElement;\nisTarget.getRefState = getRefState;\n"],"names":["targetSymbol","getElement","target","isTarget","getRefState"],"mappings":"AAEO,MAAMA,2BAAsB,QAAQ,GAiBrCC,IAAa,CAACC,MACd,aAAaA,IACRA,EAAO,UAGZ,OAAOA,EAAO,SAAU,aACnBA,EAAO,MAAA,IAGZ,OAAOA,EAAO,SAAU,WACnB,SAAS,cAAcA,EAAO,KAAK,KAGxCA,EAAO,iBAAiB,YAIxBA,EAAO,iBAAiB,UAIxBA,EAAO,iBAAiB,SACnBA,EAAO,QAMLA,IAAS,CAACA,OAAoB;AAAA,EACzC,OAAOA;AAAAA,EACP,MAAMF;AACR,IAEaG,IAAW,CAACD,MACtB,OAAOA,KAAW,aAChB,aAAaA,KAAWA,KAAWA,EAAe,SAASF,MAC7D,OAAOE,KAAW,cAAc,WAAWA,KAAU,aAAaA,GAExDE,IAAc,CAACF,MAAwBA,KAAU,WAAWA,KAAUA,EAAO;AAE1FC,EAAS,OAAOD;AAChBC,EAAS,aAAaF;AACtBE,EAAS,cAAcC;"}

package/dist/types/hooks/useBreakpoints/useBreakpoints.d.ts

@@ -14,16 +14,6 @@ export type UseBreakpointsReturn<Breakpoint extends string = string> = {
     smallerOrEqual: (breakpoint: Breakpoint) => boolean;
     /** The function that checks if the current breakpoint is between to the given breakpoints */
     between: (a: Breakpoint, b: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is greater than to the given breakpoint */
-    isGreater: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is greater than or equal to the given breakpoint */
-    isGreaterOrEqual: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is smaller than to the given breakpoint */
-    isSmaller: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is smaller than or equal to the given breakpoint */
-    isSmallerOrEqual: (breakpoint: Breakpoint) => boolean;
-    /** The function that checks if the current breakpoint is between to the given breakpoints */
-    isInBetween: (a: Breakpoint, b: Breakpoint) => boolean;
     /** The function that returns the current breakpoints */
     current: () => Breakpoint[];
     /** The function that returns the current active breakpoint */
@@ -41,7 +31,7 @@ export type UseBreakpointsReturn<Breakpoint extends string = string> = {
  * @returns {UseBreakpointsReturn<Breakpoint>} An object containing the current breakpoint
  *
  * @example
- * const { greaterOrEqual, smallerOrEqual, current } = useBreakpoints({ mobile: 0, tablet: 640, laptop: 1024, desktop: 1280 });
+ * const { greater, smaller, between, current, active, ...breakpoints } = useBreakpoints({ mobile: 0, tablet: 640, laptop: 1024, desktop: 1280 });
  */
 export declare const useBreakpoints: <Breakpoint extends string>(breakpoints: Breakpoints<Breakpoint>, strategy?: UseBreakpointsStrategy) => UseBreakpointsReturn<Breakpoint>;
 /** Breakpoints from Material UI */

package/dist/types/hooks/useClickOutside/useClickOutside.d.ts

@@ -21,7 +21,7 @@ export interface UseClickOutside {
  * @overload
  * @template Target The target element(s)
  * @param {(event: Event) => void} callback The callback to execute when a click outside the target is detected
- * @returns {(node: Target) => void} A React ref to attach to the target element
+ * @returns {StateRef<Target>} A ref to attach to the target element
  *
  * @example
  * const ref = useClickOutside<HTMLDivElement>(() => console.log('click outside'));

package/dist/types/hooks/useHover/useHover.d.ts

@@ -31,7 +31,7 @@ export interface UseHover {
  * @overload
  * @param {HookTarget} target The target element to be hovered
  * @param {(event: Event) => void} [callback] The callback function to be invoked on mouse enter
- * @returns {boolean} The state of the hover
+ * @returns {boolean} The value of the hover
  *
  * @example
  * const hovering = useHover(ref, () => console.log('callback'));
@@ -40,7 +40,7 @@ export interface UseHover {
  * @param {HookTarget} target The target element to be hovered
  * @param {(event: Event) => void} [options.onEntry] The callback function to be invoked on mouse enter
  * @param {(event: Event) => void} [options.onLeave] The callback function to be invoked on mouse leave
- * @returns {boolean} The state of the hover
+ * @returns {boolean} The value of the hover
  *
  * @example
  * const hovering = useHover(ref, options);
@@ -48,18 +48,18 @@ export interface UseHover {
  * @overload
  * @template Target The target element
  * @param {(event: Event) => void} [callback] The callback function to be invoked on mouse enter
- * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The state of the hover
+ * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The object with the ref and the value of the hover
  *
  * @example
- * const [ref, hovering] = useHover(() => console.log('callback'));
+ * const { ref, value } = useHover(() => console.log('callback'));
  *
  * @overload
  * @template Target The target element
  * @param {(event: Event) => void} [options.onEntry] The callback function to be invoked on mouse enter
  * @param {(event: Event) => void} [options.onLeave] The callback function to be invoked on mouse leave
- * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The state of the hover
+ * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The object with the ref and the value of the hover
  *
  * @example
- * const [ref, hovering] = useHover(options);
+ * const { ref, value } = useHover(options);
  */
 export declare const useHover: UseHover;

package/dist/types/hooks/useRefState/useRefState.d.ts

@@ -3,6 +3,7 @@ export interface StateRef<Value> {
     current: Value;
     state?: Value;
 }
+export declare const createRefState: <Value>(initialValue: Value | undefined, setState: (value: Value) => void) => StateRef<Value>;
 /**
  * @name useRefState
  * @description - Hook that returns the state reference of the value