@rbxts/pretty-react-hooks
v0.4.2
Published
Useful hooks for @rbxts/react
Downloads
1,806
Readme
🌺 pretty-react-hooks
An opinionated collection of useful hooks and utilites for Roblox-TS and React 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 - ⚙️
useProperty
- Tracks the state of one or more instance properties without refs
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 Companionpnpm build
- Compile the package'sout
directory
You will likely need the following extensions:
📝 License
pretty-react-hooks is licensed under the MIT License.