usehooks-ts

Patch Changes

• Fix: Update exported files

Major Changes

• a8e8968: Remove previously deprecated hooks and hooks' signatures (#503)
• a8e8968: Improve JSDoc comments and rename or make private some type aliases
• a8e8968: Prefer type over interface (#515)
• a8e8968: Move the full workspace into ES Module

Minor Changes

• 9b65ce8: Add id param to useScript hook (from #285 by @misidoro)

Patch Changes

• d881f08: Add isLocked state to the useScrollLock return (#521 by @kyrylo-soulandwolf)
• fc25779: Resolve warning when using useScrollLock in an SSR environment (#521 by @kyrylo-soulandwolf)
• d42741f: Wrap useCountdown methods with useCallback (from #326 by @gromchen)
• d42741f: Wrap useCounter methods with useCallback (from #326 by @gromchen)
• d881f08: Fixed useScrollLock leaving inline styles (#516 from @novacdenis)
• 0d99db9: chore(deps): update all non-major dependencies
• d881f08: Fixed reflow not considering the padding before the lock (#521 by @kyrylo-soulandwolf)

Patch Changes

• b88cc01: fix useResizeObserver initialSize mutation (#504 from @iuriiiurevich)
• 823b62f: Resolve scroll lock issue on ios safari (#509 by @jontewks)

Minor Changes

• 649ef39: ✨ Feature: add useScrollLock hook

Patch Changes

• 649ef39: Deprecated useLockedBody replaced by useScrollLock
• 6514683: Fix useMediaQuery by defining getMatches before use
• d8d8e5d: Upgrade dependencies

Minor Changes

• d60f1c6: Added debounce option to both useScreen and useWindowSize

Patch Changes

• 7d74e09: Release documentation for useEventCallback
• 2660580: Depreciated useFetch, see documentation for more information
• bc3f967: Deprecated useEffectOnce, useIsFirstRender and useUpdateEffect

Minor Changes

• 87a5141: Improve useOnClickOutside:

  • Prevent handling callback when clicking on a not connected element (#374 by @hooriza)
  • Add support to accept multiple references
  • Add support for touch events in addition to mouse events

• 87ba579: Fix SSR hooks by fallback with default or initial value instead of undefined

• f39078f: Updated useIntersectionObserver API and fixed #395, #271 and #182, see #464.

• a444ba7: Depreciated useElementSize replaced by useResizeObserver

• e807ab3: Create useResizeObserver hook

Patch Changes

• b5b9e1f: chore: Updated dependencies
• 4146c39: fix: useScript failed to remove script from cache when passing removeOnUnmount prop (#354 by @ShanSenanayake)
• bdf7bda: Add eslint rules to comply with verbatimModuleSyntax to avoid side-effects
• 6b582de: use tsup as bundler instead of transpiling with tsc (@BlankParticle)
• be8c35b: Fix useScreen is not rerendering on screen resize (#280 by @philipgher)

Patch Changes

• Don't remove comments during package build to keep JSdoc comments

Minor Changes

• cb6eb5c: Added an optional option param in useDocumentTitle() to reset title on un-mount (#345 by @ladislasdellinger)

Patch Changes

• b8ee088: move lodash.debounce to dependencies from peerDependencies

Minor Changes

• add1431: Created useUnmount hook
• add1431: Created useDebounceCallback and useDebounceValue hooks
• add1431: Depreciated useDebounce hook (replaced by useDebounceCallback or useDebounceValue)
• fc8a30e: Fix hydration issues in both useScreen and useMediaQuery (Fixes #394, thanks to @bryantcodesart)
• 4a9fc88: Introduce the SSR-friendly new optional { initializeWithValue?: boolean } parameter to useLocalStorage, useReadLocalStorage, useSessionStorage, useDarkMode, useTernaryDarkMode, useMediaQuery, useScreen, useWindowSize and useElementSize, see #451.
• 5c210c1: Add defaultValue option to useTernaryDarkMode and update its signature (using function overload for smooth migration)
• 5c210c1: Update useDarkMode signature (using function overload for smooth migration)
• 0321342,4a9fc88: Drop Map, Set and Date supports in use*Storage hooks, it isn't compatible with useReadLocalStorage making the API un-consistent. Use a custom serializer/deserializer instead.

Patch Changes

• add1431: Upgrade dependencies
• a192167: Upgraded react and @testing-library/react (thanks to @TheHaff)
• 0321342: Make Typescript and @typescript-eslint stricter to catch bugs sooner
• 382161a: Depreciate useImageOnLoad, too opinionated
• 382161a: Add JSdoc comments to improve DX via in-IDE documentation
• a192167: Migrate from jest to vitest (making test-suite execution 2 times faster)

Minor Changes

• 8f3c90f: Enable setting localStorage key for useDarkTheme & useTernaryDarkMode (#298 by @ubarbaxor)
• ae47c9a: Expose setting dark mode value directly (#299 by ubarbaxor)
• 771afa5: Add serialization support for use-*-storage hooks

Patch Changes

• a816d6b: Depreciated useSsr #258
• 42f3a3a: Remove the need of commenting out useEffect deps in useMediaQuery (#383 by @lisandro52)
• 9bc05f4: Fix hydration mismatch on use***Storage (fixes #176, #369 with #320 & #251)
• 771afa5: Add Date, Set & Map support to use*Storage (#309 by @AlecsFarias)
• 4b3ed4e: Fix circular dependencies (#310)
• a3588b8: Added unit tests for useFetch hook
• c326dd3: Prevent unrelated storage keys from being updated unexpectedly in useLocalStorage and useSessionStorage (#313 by @stevenvachon fixes #384)
• e8aa777: make useLocalStorage and useSessionStorage compliant with useState (fixes #204 with #242 by @valyrie97)
• c5ad2b9: Recalculate useLocalStorage & useSessionStorage default value on dynamic key change (#355 by @amirking59)
• 7406e3c: fix(useCopyToClipboard): added useCallback to 'copy' to avoid rerendering (by @nmacianx)
• ffe0f32: Set sideEffects to false in package.json

Patch Changes

• 7141d01: Upgrade internal dependencies
• Update useCopyToClipboard documentation
• Fix typo in useEventListener

Patch Changes

• hotfix: package files missing

Patch Changes

• Fix #420

Patch Changes

• 55a1904: added export map in package.json
• use named exports instead of default exports
• fix useEventListener docs typo

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Fixes

• fix hard-coded useLockedBody anchor id
• useEventListener passes options to removeEventListener (#235 by @marnusw)
• rename useBoolean, useCounter, useLockedBody and useSidebar hooks ReturnType to Output (#234 by valentinpolitov)

Fixes

• Transpile commonjs to es5 (fixes #232)

Added

• Added useToggle
• Added options in useScript (#203, #197 by @curtvict)
• Added media query support to useEventListener (#194 by @modex98)

Updated

• Remove React import line in all files

Fixes

• docs misspelling (#189 by @JoshuaCS94)
• useIntersectionObserver deps (#195 by @Guesswhoitis)

Added

• Added useDocumentTitle (#218 by @curtvict)

Updated

• Removed import React line (not needed since react 17)

Fixes

• Fixed misspelling (thanks to @alexisoney and @JoshuaCS94)

Added

• Support React 18 (#214 by @sharvit)

Updated

• Remove hooks index files
• Remove source-map

Updated

• Move usehooks-ts to the root
• Simplify config files (removing some tools)
• Split the documentation website from the workspace
• Regroup hooks related files together (test, doc, demo, hook)
• Upgrade dependencies

Added

• useEventListener now supports Document events
• useEventListener now supports native event listener options
• Add useSessionStorage (#171 by @createdbymahmood)
• Add unit tests on useHover (#169 by @createdbymahmood)

Added

• improve useCountdown interface (#160 by @PabloLION)
• add SSR unit tests on useIsClient (#161 by @createdbymahmood)

Added

• Ignore unrelated 'storage' events in useLocalStorage (#153 from @bogdanailincaipnt)

Fixes

• Revert #143 useEffectOnce (#152 from @jherr)

Fixes

• Fix useFetch (#139 from @daiky218)
• Fix useEffectOnce (#147 from @3GOMESz)

Fixes

• Revert dependencies

Added

• Memoise useBoolean (#122 from @angusd3v)
• make setter from useLocalStorage referentially stable (#133 from @jbean96)
• add support for useMediaQuery in older versions (#135 from @brycedorn)
• update dependencies

Added

• Improve useEventListener reactivity (#117 from @TunA-Kai)
• Use useIsomorphicLayoutEffect instead of useLayoutEffect
• Memoise useLocalStorage setter (from #118)

Added

• Add unit tests on useWindowSize (#112 from @createdbymahmood)
• Add unit tests on useElementSize (#111 from @createdbymahmood)
• Add useIsomorphicLayoutEffect and replace all useLayoutEffect (#116)

Fixes

• Fix use[Read]LocalStorage render cycle (#109 from @bogdanailincaipnt)

Added

• Add unit tests on useInterval (#104/#106 from @createdbymahmood)
• Add unit tests on useDarkMode (#105/#106 from @createdbymahmood)

Updated

• Update local-storage key in useTernaryDarMode (#98 from @PabloLION)
• Update local-storage key in useDarMode (#98 from @PabloLION)
• Update Typescript to 4.5.5 (minor)

Added

• Create useTernaryDarMode (#89 from @PabloLION)

Fix

• Fix esm and source map (issued (#88) by @egehandulger)

Added

• Fix types add tests on useEventListener (#82 from @egehandulger)

Added

• Add tests on useIsMounted (#75 from @DidrikLind)
• Add useCountdown() hook (#76 from @hexp1989)
• Add tests on useDebounce (#80 from @DidrikLind)

Added

• Create media query hook (#74 from @AbbalYouness)
• Add param to allow 'mouseup' event on useOnClickOutside (#69 from @JamesBarretDev)

Added

• Create useClickAnyWhere hook (#66 from @sonjoydatta)

Fixes

• Fix useTimeout and useInterval (#65 from @oluckyman).
• Fix useOnClickOutside (bug introduced in the 2.0.1).

Added

• Simplify useOnClickOutside (introduces a bug fixed in 2.0.2)

BREAKING CHANGE

• Fixing the useElementSize changes the hook interface.

Added

• Add renovate bot.
• Upgrade @Material-ui to Mui@5 (including a lot of UI refactoring)
• Upgrade Gatsby to v4.

Fix

• Re-generate package-lock.json due wrong npm version.

• Use useEventListener in the hooks when possible #DRY.
• Enforce tree-shaking support with an Eslint plugin.
• New hook: useStep() (#48 from @qlaffont).

Added

• CHANGELOG.md was created.
• SemVer started.
• Upgrade Node and NPM to publish quickly with lerna