Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/littensy/pretty-react-hooks
💐 A collection of useful hooks for roblox-ts and React
https://github.com/littensy/pretty-react-hooks
react roblox roblox-ts typescript
Last synced: 6 days ago
JSON representation
💐 A collection of useful hooks for roblox-ts and React
- Host: GitHub
- URL: https://github.com/littensy/pretty-react-hooks
- Owner: littensy
- License: mit
- Created: 2023-04-20T03:43:41.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-03T12:04:51.000Z (about 1 month ago)
- Last Synced: 2024-12-01T00:05:38.724Z (11 days ago)
- Topics: react, roblox, roblox-ts, typescript
- Language: TypeScript
- Homepage: https://npmjs.com/package/@rbxts/pretty-react-hooks
- Size: 280 KB
- Stars: 29
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-react-lua - **Repository**
- awesome-react-lua - **Repository**
README
## 🌺 [pretty-react-hooks](https://npmjs.com/package/@rbxts/pretty-react-hooks)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/littensy/pretty-react-hooks/ci.yml?branch=master&style=for-the-badge&logo=github)
[![npm version](https://img.shields.io/npm/v/@rbxts/pretty-react-hooks.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/pretty-react-hooks)
[![npm downloads](https://img.shields.io/npm/dt/@rbxts/pretty-react-hooks.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/pretty-react-hooks)
[![GitHub license](https://img.shields.io/github/license/littensy/pretty-react-hooks?style=for-the-badge)](LICENSE.md)An opinionated collection of useful hooks and utilites for [React](https://github.com/littensy/rbxts-react) in [roblox-ts](https://roblox-ts.com).
If you find a bug or have a feature request, please [open an issue](https://github.com/littensy/pretty-react-hooks/issues/new/).
## ⭐ Featured
Check out some featured hooks:
- [🦾 `useMotor`](src/use-motor/) - Creates a motor and returns a binding, a function to set the goal, and a motor API
- [⏱️ `useAsync`](src/use-async/) - A hook that runs an async function and returns the result and status
- [⚙️ `useTagged`](src/use-tagged/) - Tracks and returns a list of all instances with the given tagThis package also exports some useful utilities:
- [📕 `hoarcekat`](src/utils/hoarcekat.tsx) - Create a Hoarcekat story
- [📦 `binding utils`](src/utils/binding.ts) - Work with values that may or may not be bindingsOr, see the [full list of hooks](src/).
## 📦 Installation
This package is available for Roblox TypeScript projects on [NPM](https://www.npmjs.com/package/@rbxts/pretty-react-hooks).
```sh
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` directoryYou will likely need the following extensions:
- [Rojo VSCode extension](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo)
- [TestEZ Companion](https://marketplace.visualstudio.com/items?itemName=tacheometrist.testez-companion)
## 📝 License
pretty-react-hooks is licensed under the [MIT License](LICENSE.md).