@prodbyeagle/eagle-ui NPM

EagleUI 🦅

EagleUI is a modern, customizable UI component library by @prodbyeagle. Originally designed for prodbyeagle's websites, this library is open for everyone to use and contribute to.

Features

Customizable: Easily tailor components to align with your design system.
Modern Design: Crafted with modern design principles and best practices.
Reusable Components: Speed up your development process with a suite of reusable components.
TypeScript Support: Written in TypeScript for enhanced type safety and developer experience.

Installation

Before you begin, ensure you have Node.js and npm (or Yarn) installed.

Step-by-Step Installation

Using npm
Open your terminal and run:
```
npm install @prodbyeagle/eagle-ui
```
Using Yarn
If you prefer Yarn, run:
```
yarn add @prodbyeagle/eagle-ui
```
Verify Peer Dependencies
Some components might rely on additional peer dependencies. Make sure to check the documentation or package details for any extra requirements.

Usage

Integrate EagleUI components into your Next.js project by importing them into your pages or components. Below is a simple example:

// pages/index.tsx
import React from 'react';
import { Button } from '@prodbyeagle/eagle-ui';

const Home: React.FC = () => {
  return (
    <div style={{ padding: '2rem', textAlign: 'center' }}>
      <h1>Welcome to EagleUI</h1>
      <p>Customize and build fast with our reusable components!</p>
      <Button variant={border} onClick={() => alert('Button Clicked!')}>
        Click Me
      </Button>
    </div>
  );
};

export default Home;

This example demonstrates how to import a Button component and integrate it into your Next.js page with some basic inline styling.

Contributing

Contributions are welcome! To contribute:

Fork the repository.
Create a new branch for your feature or bug fix:
```
git checkout -b feature/YourFeatureName
```
Make your changes and commit them with a descriptive message:
```
git commit -m "Add feature: YourFeatureName"
```
Push your branch to your fork:
```
git push origin feature/YourFeatureName
```
Open a pull request on GitHub to merge your changes.

For major changes, please open an issue first to discuss what you would like to change.