Amicons

A React-based icon library for your projects. This library provides reusable and customizable SVG icons wrapped in React components.

Installation

You can install Amicons using your preferred package manager: npm, yarn, or pnpm.

npm

npm install @evans-kwofie/amicons

yarn

yarn add @evans-kwofie/amicons

pnpm

pnpm add @evans-kwofie/amicons

Usage

Import and use the icons in your React project:

import React from "react";
import { ExampleIcon } from "@evans-kwofie/amicons";

const App = () => (
  <div>
    <h1>Example Icon</h1>
    <ExampleIcon />
  </div>
);

export default App;

Available Icons

• ExampleIcon: A sample icon to demonstrate usage.

Customization

You can customize the icons by passing props to the Icon component:

import React from "react";
import { Icon } from "@evans-kwofie/amicons";

const CustomIcon = () => (
  <Icon size={48} color="red">
    <path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8z" />
    <path d="M0 0h24v24H0z" fill="none" />
  </Icon>
);

export default CustomIcon;

Development

Build

To build the library, run:

pnpm run build

Test

(Testing setup is not yet implemented.)

License

This project is licensed under the ISC License.