React Lua Hooks

This project consists of three main packages that revolves around react-lua hooks:

• Lua hooks: general-purpose collection of hooks for react-lua
• Roblox hooks: hooks specifically made for Roblox development
• react-render-hook: a utility function to quickly test React hooks

Installation

Add these packages to your dependencies:

yarn add @seaofvoices/react-lua-hooks
yarn add @seaofvoices/react-roblox-hooks

yarn add -D @seaofvoices/react-render-hook

Or if you are using npm:

npm install @seaofvoices/react-lua-hooks
npm install @seaofvoices/react-roblox-hooks

npm install @seaofvoices/react-render-hook --save-dev

Content

• Lua hooks
  • useConstant
  • useDefaultState
  • usePrevious
  • usePreviousDistinct
  • useTeardownEffect
  • useToggle
  • useUnmount
  • useDebouncedState
  • useThrottledState
• Roblox hooks
  • useService
  • useCamera
  • useCameraCFrame
  • useEvent
  • useGuiObjectSizeBinding
  • useLocalPlayer
  • useObjectLocation
  • usePropertyChange
  • useTaggedInstances
  • useTextSize
  • useViewportSize
• react-render-hook
  • renderHook
  • createRenderHook

Other Lua Environments Support

If you would like to use this library on a Lua environment where it is currently incompatible, open an issue (or comment on an existing one) to request the appropriate modifications.

The library uses darklua to process its code.