🐈‍⬛

^{A React-style hooks library designed specifically for ReactLynx.
Translations: 🇨🇳 汉语}

npm i @lynx-js/react-use

---

✨ Features

• 🎯 ReactLynx Compatible — seamlessly integrates with ReactLynx applications
• ⚛️ React-Style API — familiar hooks interface for React developers
• 🔧 Cross-Platform — built with Lynx's unique cross-platform capabilities in mind

---

📄 Docs

• MainThreadScripts
  • useMainThreadImperativeHandle — main-thread version of React's useImperativeHandle.
  • useTapLock — a hook for locking tap events.
  • useVelocity — a hook that tracks touch velocity and direction with smoothing support.
    
    
• Lifecycles
  • useEffectOnce — a modified useEffect hook that only runs once.
  • useEventListener — a hook that helps you add a global event listener as early as possible.
  • useLifecycles — calls mount and unmount callbacks.
  • useMountedState and useUnmountPromise — track if component is mounted.
  • useUnmount — calls unmount callbacks.
  • useUpdateEffect — run an effect only on updates.
    
    
• SideEffects
  • useDebounce — debounces a function.
  • useError — error dispatcher.
  • useThrottle and useThrottleFn — throttles a function.
    
    
• State
  • createMemo — factory of memoized hooks.
  • useToggle and useBoolean — tracks state of a boolean.
  • useCounter and useNumber — tracks state of a number.
  • useDefault — returns the default value when state is null or undefined.
  • useLatest — returns the latest state or props
  • useMap — tracks state of an object.
  • usePrevious — returns the previous state or props.
  • useQueue — implements simple queue.
  • useSet — tracks state of a Set.
  • useSetState — creates setState method which works like this.setState.

---

🙏 Credits

Many hooks in this library are built upon the excellent foundation provided by react-use. We extend our gratitude to the maintainers and contributors for their outstanding work in the React hooks ecosystem.

We also draw inspiration from other amazing projects:

• kripod/react-hooks
• vueuse/vueuse
• alibaba/hooks

---

Made with ❤️ for the ReactLynx community