README.md

📱
react-use-native

The react-use fork for react-native

It doesn't depend on 'react-dom'.
A better choice for React Native development for native apps only.




^{Collection of essential React Hooks. Port of libreact.
Translations: 🇨🇳 汉语}

npm i react-use-native

• Animations
  • useRaf — re-renders component on each requestAnimationFrame.
  • useInterval — re-renders component on a set interval using setInterval.
  • useTimeout — re-renders component after a timeout.
  • useTimeoutFn — calls given function after a timeout.
  • useUpdate — returns a callback, which re-renders component when called.
    
    
• Side-effects
  • useAsync, useAsyncFn, and useAsyncRetry — resolves an async function.
  • useDebounce — debounces a function.
  • useError — error dispatcher.
  • useRafLoop — calls given function inside the RAF loop.
  • useThrottle and useThrottleFn — throttles a function.
    
    
• Lifecycles
  • useEffectOnce — a modified useEffect hook that only runs once.
  • useLifecycles — calls mount and unmount callbacks.
  • useMountedState and useUnmountPromise — track if component is mounted.
  • usePromise — resolves promise only while component is mounted.
  • useLogger — logs in console as component goes through life-cycles.
  • useMount — calls mount callbacks.
  • useUnmount — calls unmount callbacks.
  • useUpdateEffect — run an effect only on updates.
  • useIsomorphicLayoutEffect — useLayoutEffect that that works on server.
  • useDeepCompareEffect, useShallowCompareEffect, and useCustomCompareEffect
    
    
• State
  • createMemo — factory of memoized hooks.
  • createReducer — factory of reducer hooks with custom middleware.
  • createReducerContext and createStateContext — factory of hooks for a sharing state between components.
  • useDefault — returns the default value when state is null or undefined.
  • useGetSet — returns state getter get() instead of raw state.
  • useGetSetState — as if useGetSet and useSetState had a baby.
  • useLatest — returns the latest state or props
  • usePrevious — returns the previous state or props.
  • usePreviousDistinct — like usePrevious but with a predicate to determine if previous should update.
  • useObservable — tracks latest value of an Observable.
  • useRafState — creates setState method which only updates after requestAnimationFrame.
  • useSetState — creates setState method which works like this.setState.
  • useStateList — circularly iterates over an array.
  • useToggle and useBoolean — tracks state of a boolean.
  • useCounter and useNumber — tracks state of a number.
  • useList and useUpsert — tracks state of an array.
  • useMap — tracks state of an object.
  • useSet — tracks state of a Set.
  • useQueue — implements simple queue.
  • 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.
  • useMediatedState — like the regular useState but with mediation by custom function.
  • useFirstMountState — check if current render is first.
  • useRendersCount — count component renders.
  • createGlobalState — cross component shared state.
  • useMethods — neat alternative to useReducer.
    
    
• Miscellaneous
  • useEnsuredForwardedRef and ensuredForwardRef — use a React.forwardedRef safely.

Usage — how to import.
Unlicense — public domain.
Support — add yourself to backer list below.

Contributors