@ucheeddev/react-web
v1.0.2
Published
Custom React Web package
Readme
@ucheeddev/react-web 🚀
A utility package for general React web development. This package provides reusable hooks 🪝, utilities 🛠️, and components 🧩 to speed up your development and maintain consistency across projects.
🌟 Features
- 🪝 Hooks: Simplify state management and other React tasks.
- 🛠️ Utils: Common utility functions for everyday programming needs.
- 🧩 Components: Prebuilt, customizable UI components.
📦 Installation
Install the package via npm:
npm install @ucheeddev/react-web🚀 Getting Started
Import Structure 📂
The package is organized into three main modules:
Hooks
Import like this:import { useCustomHook } from '@ucheeddev/react-web/hooks';Utils
Use utility functions like this:import { formatDate } from '@ucheeddev/react-web/utils';Components
Add components to your project:import { CustomButton } from '@ucheeddev/react-web/components';
🪝 Available Hooks
useCustomHook
A powerful hook for handling XYZ.
Usage Example:
import { useCustomHook } from '@ucheeddev/react-web/hooks';
const MyComponent = () => {
const [state, setState] = useCustomHook();
return <div>{state}</div>;
};🛠️ Available Utilities
formatDate
Format a date string into a human-readable format.
Usage Example:
import { formatDate } from '@ucheeddev/react-web/utils';
const date = '2025-01-01';
console.log(formatDate(date)); // Output: Jan 1, 2025🧩 Available Components
CustomButton
A reusable button component with customizable styles and behaviors.
Props:
| Prop | Type | Description |
|----------|----------|---------------------------|
| label | string | The text displayed on the button. |
| onClick| function | A function triggered when the button is clicked. |
Usage Example:
import { CustomButton } from '@ucheeddev/react-web/components';
const App = () => (
<CustomButton label="Click Me" onClick={() => alert('Button clicked!')} />
);🤝 Contributing
We ❤️ contributions!
If you have a bug to report or a feature to suggest:
- Open an issue or submit a pull request on GitHub.
- Follow our contribution guidelines (coming soon!).
📄 License
This package is licensed under the MIT License.
📢 Stay Connected
For updates and more packages, follow @ucheeddev on:
Feel free to adapt the examples and links based on your actual hooks, utils, and components! Let me know if you'd like help automating this file. 🎉
