@rbxts/pretty-react-hooks
TypeScript icon, indicating that this package has built-in type declarations

0.5.0 • Public • Published

GitHub Workflow Status npm version npm downloads GitHub license

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:

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:

 

📝 License

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

Readme

Keywords

Package Sidebar

Install

npm i @rbxts/pretty-react-hooks

Weekly Downloads

432

Version

0.5.0

License

MIT

Unpacked Size

141 kB

Total Files

183

Last publish

Collaborators

  • littensy