@geneui/icons

The icons library created for the Gene UI design system.

Getting Started

The icons in this package are now available as full React components, making it easy to integrate them directly into your project.

⚙️ Installation

1. Install @geneui/icons as a dependency:

   Using NPM:

   npm install @geneui/icons --save

   Or, using Yarn:

   yarn add @geneui/icons

👨‍💻 Usage

To utilize the icons from the Gene UI icons collection as React components with customizable size and color, follow these steps:

1. Import an Icon:

   Import the desired icon directly from the Gene UI icons collection. For example, to import the Check icon:

   import { Check } from '@geneui/icons';

2. Use the Icon as a Component:

   Use the imported icon directly in your JSX and customize it with size and color props:

   <Check size={24} color="red" />

Icon Props

The icons accept the following props:

• size (optional): Defines the size of the icon. Can be one of 12, 16, 20, 24, 28, 32, 48.
• color (optional): Defines the color of the icon. Accepts any valid CSS color value.

This allows you to seamlessly integrate and customize icons from the Gene UI icons collection as React components in your project.

👍 Contributing

We welcome contributions from the community! Here's how you can get involved to add, remove, or rename icons:

👉 See the contributing docs.

⚖️ License

The Gene UI design system's icons are licensed under the MIT License.