@rbxts/pretty-roact-hooks v3.2.1
๐บ pretty-roact-hooks
An opinionated collection of useful hooks and utilites for Roblox-TS and Roact Hooked.
Every hook has documentation and tests. 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:
- ๐งช
renderHook
- Render a hook in a test environment - ๐
hoarcekat
- Create a Hoarcekat story with hook detection - ๐ฆ
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-roact-hooks @rbxts/flipper @rbxts/roact-hooked
or
pnpm add @rbxts/pretty-roact-hooks @rbxts/flipper @rbxts/roact-hooked
ย
๐ป 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 npm install
or pnpm install
. Then, you can run the following commands:
pnpm dev
- Enable watch mode with thegame
project typepnpm build
- Build the package
You will likely need the following extensions:
ย
๐ License
pretty-roact-hooks is licensed under the MIT License.
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago