README.md

November 20, 2024 ยท View on GitHub

Overview

Effortless Icons

  • Icon components for different frameworks/libraries
  • Popular Icon Packs (Heroicons, Lucide Icons, etc.)
  • Icon Themes (different versions of the same icon)
  • Builder Template to Create your own Icon Packs
<!-- svelte example -->
<script>
	import { Icon } from '@steeze-ui/svelte-icon'
	import { Bolt } from '@steeze-ui/heroicons'
</script>

<Icon src="{Bolt}" theme="solid" class="color-gray-900" />

Deploy your own Icon Pack

Copy the Builder Template to easily create and publish your own Icon Pack.

Packages

Icon Components

PackageVersion
@steeze-ui/svelte-icon
@steeze-ui/lit-icon
@steeze-ui/solid-icon
@steeze-ui/react-icon
@steeze-ui/vue-icon

Icon Packs

PackageThemesSourcesBrowserPackage VersionSrc Version
@steeze-ui/heroiconsdefault(outline), solid, minitailwindlabs/heroiconsbrowse2.2.0
@steeze-ui/simple-iconsdefaultsimple-icons/simple-iconsbrowse13.17.0
@steeze-ui/tabler-iconsdefault(outline), filledtabler/tabler-iconsbrowse3.22.0
@steeze-ui/radix-iconsdefaultradix-ui/iconsbrowse5.0.0
@steeze-ui/material-design-iconsdefault(filled), outlined, rounded, sharp, twotonegoogle/material-design-iconsbrowse1.14.9
@steeze-ui/lucide-iconsdefaultlucide-icons/lucidebrowse0.408.0
@steeze-ui/phosphor-iconsthin, light, default(regular), bold, fill, duotonePhosphor Iconsbrowse2.1.1
@steeze-ui/carbon-iconsdefaultcarbon-design-system/carbonbrowse11.21.0
@steeze-ui/remix-iconsdefault(outline), solidRemix-Design/RemixIconbrowse4.2.0
@steeze-ui/iconic-freedefaulticonic.appbrowse-
@steeze-ui/octiconsdefault(16), 24, 12primer/octiconsbrowse19.3.0
@steeze-ui/css-ggdefaultCSS.gg Iconsbrowse2.1.1
@steeze-ui/font-awesomedefault, solidFont Awesomebrowse6.5.1
@steeze-ui/feather-icons (deprecated)defaultfeathericons/featherbrowse4.29.1

Utilities

PackageVersion
@steeze-ui/icons

Development

This monorepo uses pnpm. To build a new version of the packages just run:

pnpm install && pnpm package