littensy/pretty-react-hooks

💐 A collection of useful hooks for roblox-ts and React

🌺 pretty-react-hooks

An opinionated collection of useful hooks and utilites for React in roblox-ts.

If you find a bug or have a feature request, please open an issue.

 

⭐ Featured

Check out some featured hooks:

• 🦾 useMotor - Creates a motor and returns a binding, a function to set the goal, and a motor API
• ⏱️ useAsync - A hook that runs an async function and returns the result and status
• ⚙️ useTagged - Tracks and returns a list of all instances with the given tag

This package also exports some useful utilities:

• 📕 hoarcekat - Create a Hoarcekat story
• 📦 binding utils - Work with values that may or may not be bindings

Or, see the full list of hooks.

 

📦 Installation

This package is available for Roblox TypeScript projects on NPM.

npm install @rbxts/pretty-react-hooks
yarn add @rbxts/pretty-react-hooks
pnpm add @rbxts/pretty-react-hooks

 

🌻 Contributing

Contributions are welcome! Note that if you make a change to a hook, you should also check the tests and documentation.

To get started, clone the repository and run pnpm install. Then, you can run the following commands:

• pnpm dev - Enable watch mode with support for TestEZ Companion
• pnpm build - Compile the package's out directory

You will likely need the following extensions:

• Rojo VSCode extension
• TestEZ Companion

 

📝 License

pretty-react-hooks is licensed under the MIT License.

pretty-react-hooks's Issues

useCamera can return undefined

The current camera connection uses a non-null assertion when retrieving the camera. This should instead be wrapped in an if statement.

Some tests that yield are inconsistent

A lot of tests yield in order to test things like debounces and timers, and they can be inconsistent across different devices.

Some changes are needed to make these tests more repeatable.

Bug with package if it used by the plugin

I was making a plugin using React and I found a problem: if you reload the plugin (during an update or just disable/enable) the React breaks
After some digging, I found that the problem is _G.ROACT_17_MOCK_SCHEDULER.
if that variable is not nil, react will not render the root

that can be a problem for the plugins using React, if ROACT_17_MOCK_SCHEDULER is not nil they will not be able to render the plugin GUI.
the only file that sets it is testez
out -> utils -> testez

Is it possible to delay requiring that script or at least setting this flag when some of its components are used?

something like

let initialized = false

function checkInitialization(){
 if(initialized) return;
 initialized = true;
 _G.__ROACT_17_MOCK_SCHEDULER__ = true;
}

function ...Hook(){
checkInitialization()
 ...
}

Add support for flipbook

https://github.com/flipbook-labs/flipbook