Skip to content

v2.0.0

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 28 May 23:18
v2.0.0
3e5dda4

2.0.0 (2024-05-28)

⚠ BREAKING CHANGES

  • useClock: No longer provides the tick constants (DAYS, HOURS, etc), use the date-fns comparison functions.
  • useTimeout: timer.isActive is now a read-only boolean instead of a getter function.
  • useInterval: timer.isActive is now a read-only boolean instead of a getter function.
  • useDerivedState: Now resets its value immediately when dependencies change, instead of waiting for next effect loop. This ensures that outgoing state is always in sync with incoming state.
  • hooks/useTimers: This file has now been separated into its constituent imports.
  • usePageHash: Actually returns the hash now, instead of a object.
  • usePropsMemo: This functionality is now incorporated into useStableMemo
  • useWillUnmount: Use useMountEffect instead.
  • useChildren: Replaced with useMemoChildren

removed

  • useClock: No longer provides the tick constants (DAYS, HOURS, etc), use the date-fns comparison functions. (f95e96b)

Removed

  • hooks/useTimers: This file has now been separated into its constituent imports. (f95e96b)
  • useChildren: Replaced with useMemoChildren (6397634)
  • usePropsMemo: This functionality is now incorporated into useStableMemo (6397634)
  • useWillUnmount: Use useMountEffect instead. (6397634)

Features

  • All new typescript definitions for vscode completion. (f95e96b)
  • SelectionContext: Context provider for managing a value selections across nested components. (f95e96b)
  • StatedContext: Context provider for managing state across nested components. (f95e96b)
  • useChanged: New hook for identifying when dependencies have been modified. (f95e96b)
  • useDebouncedEffect: Can now accept anything for its dependencies. (f95e96b)
  • useDebouncedEffect: Now accepts a dependency comparison option on the fifth argument. (f95e96b)
  • useDeferredUpdate: New hook that generates an update callback that is guaranteed to never cause a state change during render. (f95e96b)
  • useGettableState: Added the defer option to the setter function, and corrusponding alwaysDefer option to the hook invocation. This controls if calling the setter should immediately trigger setState, or defer to the next cycle of the event loop. Setting to true allows for writes during the render function without triggering a “State change during render” error. (f95e96b)
  • useGettableState: Added the immedate option to the setter function, and corrusponding alwaysImmediate option to the hook invocation. This controls if the state update should happen when the setter is called, or if it should wait for rerender. (f95e96b)
  • useImmediateEffect: Now accepts a dependency comparison option on the third argument. (f95e96b)
  • useIntervalUpdate: New hook for triggering a component refreshes every N milliseconds since last update. (f95e96b)
  • useLocalStorage: Now has an isJSON option to disable json parsing/serializing of stored values. Defaults to true. (f95e96b)
  • useMountEffect: New strict-mode safe hook for executing effects only on mount and dismount. (f95e96b)
  • useSessionStorage: Now has an isJSON option to disable json parsing/serializing of stored values. Defaults to true. (f95e96b)
  • useSmartEffect: New hook. Identical to useEffect, but can use anything as a dependency and performs deep comparison of dependencies by default. (f95e96b)
  • useSuspense: New hook for performing an async task across a react suspension. (f95e96b)
  • useUpdateEffect: Can now accept anything for its dependencies. (f95e96b)
  • useUpdateEffect: Now accepts a dependency comparison option on the third argument. (f95e96b)
  • useViewportIsIdle: New hook for tracking if the user is inactive. (f95e96b)

Bug Fixes

  • useClock: No longer incorrectly triggers an update immediately after first render. (f95e96b)
  • useClock: Now functions properly in StrictMode (f95e96b)
  • useDebounce: Now functions properly in StrictMode (f95e96b)
  • useDefer: Fixed a bug that would cause the timeout handle to get lost on component refresh (f95e96b)
  • useDerivedState: Now resets its value immediately when dependencies change, instead of waiting for next effect loop. This ensures that outgoing state is always in sync with incoming state. (f95e96b)
  • useGettableState: Now supports passing a callback to the setter function, same as the native useState. (f95e96b)
  • useGettableState: The getter and setter functions will no longer change every render if the initial value is an object or array. (f95e96b)
  • useInterval: timer.isActive is now a read-only boolean instead of a getter function. (f95e96b)
  • useInterval: Now functions properly in StrictMode (f95e96b)
  • useMemoObject: Now accepts anything as a dependency. (f95e96b)
  • usePageHash: Actually returns the hash now, instead of a object. (f95e96b)
  • useStableMemo: Now correctly detects a dependency change if dependencies becomes a falsy value. (f95e96b)
  • useTimeout: timer.isActive is now a read-only boolean instead of a getter function. (f95e96b)
  • useTimeout: Fixed a bug that would cause the timeout handle to get lost on component refresh (f95e96b)
  • useTimeout: Now functions properly in StrictMode (f95e96b)
  • useTimeout: When the timeout function is provided on the hook instead of the set() function, the timeout will now always invoke the latest rendered instance of the function. Previously it would render the instance at the time set() was called. (f95e96b)
  • useUpdateEffect: Now functions properly in StrictMode (f95e96b)
Assets 2
Loading