Akashmathad/react-smart-utils

A simple, smart hooks and utility functions to make development easier

⚠️ This library is in beta version might be all hooks are not yet ready! we will soon dispatch hooks with bulletproof tests 🚀

---

Discord: https://discord.gg/DTJV27BYwA

React Smart Utils Library

A comprehensive set of utility functions and components designed to streamline development with React and TypeScript. This library helps improve your workflow with reusable components and functions, customizable and extensible to meet the needs of various React projects.

---

• Docs

Table of Contents

• Installation
• Features
• Usage
• Example Hooks
• Available Hooks
• Contributing
• Code Style Guidelines
• Roadmap
• License

---

Installation

To install the React Smart Utils library, use npm or yarn:

npm install react-smart-utils

or

yarn add react-smart-utils

---

Features

• Custom Hooks: Reusable React hooks to solve common use cases.
• Utility Functions: Handy utilities to simplify everyday coding tasks.
• TypeScript Support: Fully typed with TypeScript for a smooth developer experience.
• Tree-shakable: Only include what you need, minimizing bundle size.

---

Contributing

We welcome contributions! Please follow the instructions below to set up the project for development and make your contributions.

1. Fork the repositoryon GitHub.
2. Clone your forked repository:

git clone https://github.com/your-username/react-smart-utils.git
cd package
yarn install

3.Test your functions or hooks in smart-app:

cd smart-app
yarn install
yarn dev

Note: You can push example code as it helps in preparing documents (When Raise PR you must paste the path in PR description)

4.Create a new branch for your feature:

git checkout -b feature/my-new-feature

5. Make your changes, then commit and push:

git commit -m "Add new feature"
git push origin feature/my-new-feature

Submit a Pull Request with a detailed explanation of your changes.