@ucheeddev/refine-core 🚀

A utility package for general Refine-powered 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/refine-core

🚀 Getting Started

Import Structure 📂

The package is organized into three main modules:

1. Hooks
   Import like this:

   import { useCustomHook } from '@ucheeddev/refine-core/hooks';

2. Utils
   Use utility functions like this:

   import { formatDate } from '@ucheeddev/refine-core/utils';

3. Components
   Add components to your project:

   import { CustomButton } from '@ucheeddev/refine-core/components';

🪝 Available Hooks

useCustomHook

A powerful hook for handling XYZ.

Usage Example:

import { useCustomHook } from '@ucheeddev/refine-core/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/refine-core/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/refine-core/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:

1. Open an issue or submit a pull request on GitHub.
2. 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:

• 🌐 Website
• 💼 LinkedIn

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. 🎉