Port remaining hooks from `react-use`

[JoeDuncko]

Our goal with @react-hookz/web is to give the react community a general-purpose React hooks library built with care.

We'd like to port the remaining hooks from react-use (the project @react-hookz/web grew out of) while keeping in mind our tenants:

• General-purposeness (hooks should fulfill a wide array of use cases)
• Composability (a preference for hooks that are useful for building other hooks)
• No or very few dependencies
• SSR compatibility
• 100% test coverage (ideally)
• Concrete example use cases

Hooks to port

Sensors

• [ ] useBattery — tracks device battery state.
• [ ] useGeolocation — tracks geo location state of user's device.
• [ ] useHover — tracks mouse hover state of some element.
• [ ] useHoverDirty — tracks mouse hover state of some element.
• [x] useHash — tracks location hash value. (No plans to implement. Instead, use one the various routing libraries available.)
• [ ] useIdle — tracks whether user is being inactive.
• [x] useIntersection — tracks an HTML element's intersection. (Implemented as useIntersectionObserver)
• [x] useKey — track keys. (Implemented as useKeyboardEvent)
• [x] useKeyPress — track keys. (Implemented as useKeyboardEvent)
• [x] useKeyboardJs — track keys. (Implemented as useKeyboardEvent)
• [x] useKeyPressEvent — track keys. (Implemented as useKeyboardEvent)
• [x] useLocation — tracks page navigation bar location state. (No plans to implement. Instead, use one the various routing libraries available.)
• [x] useSearchParam — tracks page navigation bar location state. (No plans to implement. Instead, use one the various routing libraries available.)
• [ ] useLongPress — tracks long press gesture of some element.
• [x] useMedia — tracks state of a CSS media query. (implemented as useMediaQuery)
• [ ] useMediaDevices — tracks state of connected hardware devices.
• [ ] useMotion — tracks state of device's motion sensor.
• [ ] useMouse — tracks state of mouse position.
• [ ] useMouseHovered — tracks state of mouse position.
• [ ] useMouseWheel — tracks deltaY of scrolled mouse wheel.
• [x] useNetworkState — tracks the state of browser's network connection. (implemented as useNetwork)
• [ ] useOrientation — tracks state of device's screen orientation.
• [ ] usePageLeave — triggers when mouse leaves page boundaries.
• [ ] useScratch — tracks mouse click-and-scrub state.
• [ ] useScroll — tracks an HTML element's scroll position.
• [ ] useScrolling — tracks whether HTML element is scrolling.
• [ ] useStartTyping — detects when user starts typing.
• [ ] useWindowScroll — tracks Window scroll position.
• [x] useWindowSize — tracks Window dimensions.
• [x] useMeasure — tracks an HTML element's dimensions. (implemented as useMeasure)
• [x] useSize — tracks an HTML element's dimensions. (Use useWindowSize instead)
• [x] createBreakpoint — tracks innerWidth (Not planning to implement)
• [ ] useScrollbarWidth — detects browser's native scrollbars width.

UI

• [ ] useAudio — plays audio and exposes its controls.
• [x] useClickAway — triggers callback when user clicks outside target area. (Implmented as useClickOutside)
• [ ] useCss — dynamically adjusts CSS.
• [ ] useDrop — tracks file, link and copy-paste drops.
• [ ] useDropArea — tracks file, link and copy-paste drops.
• [ ] useFullscreen — display an element or video full-screen.
• [ ] useSlider — provides slide behavior over any HTML element.
• [ ] useSpeech — synthesizes speech from a text string.
• [ ] useVibrate — provide physical feedback using the Vibration API.
• [ ] useVideo — plays video, tracks its state, and exposes playback controls.

Animations

• [ ] useRaf — re-renders component on each requestAnimationFrame.
• [x] useInterval and useHarmonicIntervalFn — re-renders component on a set interval using setInterval. (Implemented as useIntervalEffect).
• [ ] useSpring — interpolates number over time according to spring dynamics.
• [x] useTimeout — re-renders component after a timeout. (Can be composed from other hooks, see migration guide).
• [x] useTimeoutFn — calls given function after a timeout. (Implemented as useTimeoutEffect).
• [ ] useTween — re-renders component, while tweening a number from 0 to 1.
• [x] useUpdate — returns a callback, which re-renders component when called. (Implemented as useRerender)

Side-effects

• [x] useAsync — resolves an async function. (implemented as useAsync)
• [x] useAsyncFn — resolves an async function. (implemented as useAsync)
• [x] useAsyncRetry — resolves an async function. (implemented as useAsync)
• [x] useBeforeUnload — shows browser alert when user try to reload or close the page. (No plans to implement, address migration guide for workaround)
• [x] useCookie — provides way to read, update and delete a cookie. (implemented as useCookieValue)
• [x] useCopyToClipboard — copies text to clipboard. (no plans to implement - use browser's API instead)
• [x] useDebounce — debounces a function. (Implemented as useDebounceCallback)
• [ ] useError — error dispatcher.
• [x] useFavicon — sets favicon of the page. (Hooks that modify the element will not be implemented).
• [x] useLocalStorage — manages a value in localStorage. (Implemented as useLocalStorageValue)
• [ ] useLockBodyScroll — lock scrolling of the body element.
• [ ] useRafLoop — calls given function inside the RAF loop.
• [x] useSessionStorage — manages a value in sessionStorage. (Implemented as useSessionStorageValue)
• [x] useThrottle — throttles a function.
• [x] useThrottleFn — throttles a function.
• [x] useTitle — sets title of the page. (Hooks that modify the element will not be implemented).
• [x] usePermission — query permission status for browser APIs. (Implemented as usePermission)

Lifecycles

• [x] useEffectOnce — a modified useEffect hook that only runs once. (it's just an alias for useMountEffect)
• [x] useEvent — subscribe to events. (Implemented as useEventListener)
• [x] useLifecycles — calls mount and unmount callbacks. (no sense to port, has almost no benefit comparing to useEffect)
• [x] useMountedState — track if component is mounted. (Implemented as useIsMounted)
• [x] useUnmountPromise — track if component is mounted. (No plans to implement).
• [x] usePromise — resolves promise only while component is mounted. (No plans to implement)
• [x] useLogger — logs in console as component goes through life-cycles. (Implemented as useLifecycleLogger
• [x] useMount — calls mount callbacks. (Implemented as useMountEffect)
• [x] useUnmount — calls unmount callbacks. (Implemented as useUnmountEffect)
• [x] useUpdateEffect — run an effect only on updates. (Implemented as useUpdateEffect)
• [x] useIsomorphicLayoutEffect — useLayoutEffect that does not show warning when server-side rendering. (Implemented as useIsomorphicLayoutEffect)
• [x] useDeepCompareEffect — run an effect depending on deep comparison of its dependencies. (Implemented as useDeepCompareEffect)
• [ ] useShallowCompareEffect — run an effect depending on deep comparison of its dependencies
• [x] useCustomCompareEffect — run an effect depending on deep comparison of its dependencies. (Implemented as useCustomCompareEffect)

State

• [x] createMemo — factory of memoized hooks. (Not planning to implement)
• [x] createReducer — factory of reducer hooks with custom middleware. (Not planning to implement)
• [x] createReducerContext — factory of hooks for a sharing state between components. (Not planning to implement)
• [x] createStateContext — factory of hooks for a sharing state between components. (Not planning to implement)
• [x] useDefault — returns the default value when state is null or undefined. (No plans to implement. Use useMediatedState instead).
• [x] useGetSet — returns state getter get() instead of raw state. (No plans to implement)
• [x] useGetSetState — as if useGetSet and useSetState had a baby. (No plans to implement)
• [x] useLatest — returns the latest state or props (Implemented as useSynchedRef)
• [x] usePrevious — returns the previous state or props. (Implemented as usePrevious)
• [x] usePreviousDistinct — like usePrevious but with a predicate to determine if previous should update. (Implemented as usePreviousDistinct)
• [ ] useObservable — tracks latest value of an Observable.
• [ ] useRafState — creates setState method which only updates after requestAnimationFrame.
• [x] useSetState — creates setState method which works like this.setState. (No plans to implement)
• [ ] useStateList — circularly iterates over an array.
• [x] useToggle — tracks state of a boolean. (Implemented as useToggle)
• [x] useBoolean — tracks state of a boolean. (Implemented as useToggle)
• [x] useCounter — tracks state of a number.
• [x] useNumber — tracks state of a number. (Implemented as useCounter)
• [x] useList — tracks state of an array.
• [x] useUpsert — tracks state of an array. (Use useList instead.)
• [x] useMap — tracks state of an object. (Implemented as useMap)
• [x] useSet — tracks state of a Set. (Implemented as useSet)
• [x] useQueue — implements simple queue. (Implemented as useQueue)
• [x] useStateValidator — tracks state of an object.
• [ ] useStateWithHistory — stores previous state values and provides handles to travel through them.
• [ ] useMultiStateValidator — alike the useStateValidator, but tracks multiple states at a time.
• [x] useMediatedState — like the regular useState but with mediation by custom function. (Implemented as useMediatedState)
• [x] useFirstMountState — check if current render is first. (Implemented as useFirstMountState)
• [x] useRendersCount — count component renders. (Implemented as useRenderCount).
• [x] createGlobalState — cross component shared state. (Not planning to implement)
• [x] useMethods — neat alternative to useReducer. (No plans to implement)

Miscellaneous

• [ ] useEnsuredForwardedRef — use a React.forwardedRef safely.
• [ ] ensuredForwardRef — use a React.forwardedRef safely.

Join our community!

Have a question? Create a discussion on GitHub or join our Discord community.

Interested in contributing code? Check out our contribution guide. We are excited to see your pull request!

[xobotyi]

@JoeDuncko dang it! we already have a queue hook, but it is missing from hooks listing🤦‍♂️

[JoeDuncko]

@JoeDuncko dang it! we already have a queue hook, but it is missing from hooks listing🤦‍♂️

@xobotyi Ah crap, I can knock that out if no one else does tomorrow.

[malavshah9]

@JoeDuncko @xobotyi I was just looking to work on useCopyToClipboard, but then found this discussion where we have concluded that it is not needed at the moment. Can we remove this from this list also, if we don't want to build it.

[malavshah9]

@JoeDuncko @xobotyi Moreover, I am looking to work on useSpeech with the following definition, is this fine or do we want to improve here?

type SpeechOptions = {
  lang: string;
  voice?: SpeechSynthesisVoice;
  rate: number;
  pitch: number;
  volume: number;
};
export type VoiceInfo = Pick<SpeechSynthesisVoice, 'lang' | 'name'>;

export type ISpeechState = SpeechOptions & {
  isPlaying: boolean;
  status: string;
  voiceInfo: VoiceInfo;
};

enum Status {
  init,
  play,
  pause,
  end,
}

const useSpeech = (text: string, options: ISpeechOptions): ISpeechState

Same as we have in react-use

[xobotyi]

@malavshah9 sold!

[malavshah9]

@xobotyi I wanted to work and port below mentioned hooks:

1. useIdle
2. useRaf
3. useGeolocation
4. useStateList

[xobotyi]

@malavshah9 it would be way better if youll help with tests migration so we can switch towards react 18

https://github.com/react-hookz/web/pull/1377

I will update that PR so it is containing only tests changes without, and after that youll be able to migrate tests

[malavshah9]

@xobotyi I would love to do that. Should I start migrating that for each hooks and giving you separate PR?