0.1.0 • Published 1 year ago

anaj-ui v0.1.0

Weekly downloads
-
License
GPL-3.0
Repository
-
Last release
1 year ago

AnajUI

GitHub Badge LinkedIn Badge Twitter Badge Website Badge

Introduction

AnajUI is a React component library offering customizable elements for landing pages, such as Hero sections, Features, and Footers. It empowers developers to build responsive, modern designs effortlessly, while maintaining flexibility and brand uniqueness.

Supported React.js

This package supports React.js 18.2.0 and above.

Installation

To install anaj-ui, simply run:

npm install anaj-ui

Or with Yarn:

yarn add anaj-ui

Usage

Navigation

To use the Navigation component from AnajUI, first import it into your React project:

import { Navigation } from 'anaj-ui';

Then, you can use it in your component like so:

const App = () => {
  const navLinks = [
    { name: "Home", href: "/", isSpecial: false },
    { name: "About", href: "/about", isSpecial: false },
    { name: "Services", href: "/services", isSpecial: true, specialColor: "blue-500" },
    { name: "Contact", href: "/contact", isSpecial: false },
  ];

  const logo = {
    src: "/path/to/logo.png",
    alt: "Logo Alt Text",
  };

  return (
    <div>
      <Navigation
        navLinks={navLinks}
        logo={logo}
        logoSize="w-20 h-20" // Optional: Adjust logo size
        defaultColor="text-gray-800"
        hoverColor="text-blue-500"
      />
      {/* Other components */}
    </div>
  );
};

Footer

To use the Footer component from AnajUI, first import it into your React project:

import { Footer } from 'anaj-ui';

Then, you can use it in your component like so:

import React from 'react';
import { Footer } from 'anaj-ui';

const App = () => {
  const footerLinks = [
    {
      title: "Docs",
      links: [
        { 
          name: "Develop", 
          href: "/docs", 
        },
      ],
    },
    {
      title: "Community",
      links: [
        { 
          name: "Feedback", 
          href: "mailto:packshipcli@gmail.com", 
        },
        { 
          name: "LinkedIn", 
          href: "https://linkedin.com/in/h4temsoliman", 
        },
        { 
          name: "GitHub", 
          href: "https://github.com/codenkoffee", 
        },
        { 
          name: "X", 
          href: "https://x.com/h4temsoliman", 
        },
        { 
          name: "Portfolio", 
          href: "https://hatemsoliman.dev", 
        },
      ],
    },
    {
      title: "More",
      links: [
        { 
          name: "Purchase", 
          href: "#start-packshipping",
        },
        { 
          name: "Contact", 
          href: "mailto:packshipcli@gmail.com",
        },
        { 
          name: "Fund Me", 
          href: "https://paypal.me/h4temsoliman?country.x=EG&locale.x=en_US",
        },
      ],
    },
  ];

  return (
    <div>
      <Footer
        footerLinks={footerLinks}
        brandName="AnajUI"
        defaultColor="text-blue-500"
        footerLogo="/path/to/logo.png"
      />
    </div>
  );
};

export default App;

This example demonstrates how to integrate the Footer component from AnajUI into your application, providing a customizable footer for your website.

Features

  • Light and dark themes
  • Versatile and customizable components
  • Support for different types of content

Contributing

Contributions are welcome! Please open an issue or submit a pull request to contribute to the AnajUI project.

License

This project is licensed under the GPL-3.0 license.