READ THIS FIRST

This project is still in experimental development. Expect bugs and breaking changes!

Overview

Effortless React Icon Component

• Made and tested for Vite environments
• Usable with all official Icon Packs
• Dynamically change theme on runtime

Installation

npm i -D @steeze-ui/react-icon

Usage

//import icon component
import {Icon} from '@steeze-ui/solid-icon'

//import as many icons from any Icon Pack
import {LightningBolt} from '@steeze-ui/heroicons'

//Use the Icon in your App
const MyApp = () => {
  return <Icon src={LightningBolt} theme='solid' class='color-gray-900'>
}

Documentation

Icon attributes

| Attribute | Default | Description | | --------- | ------- | ---------------------------------------------------------------------- | | src | - | (required) The source of a icon coming from an Icon Pack | | theme | default | Configures to use a Icon Theme if available (otherwise render nothing) | | size | 100% | Configures width and height | | * | - | Any html attribute that is valid (e.g aria-hidden, class or style) |

Icon Packs

For all available Icon Packs visit steeze-ui/icons

Development

This repo uses pnpm. To build a new version of the package just run:

pnpm install && pnpm package