Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.05 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.05 KB

fh-heroicons

Any use of the code retrieved from heroicons.com is subject to the terms of the Heroicons license, found here.


This is a small library that let's you use heroicons as FastHTML ft components:

  • Only saves the icons you use
  • Icons are downloaded on the first use and cached locally in your working directory.
  • full customization through css

Installation

pip install git+https://github.com/vacmar01/fh-heroicons.git

Usage

from fh_heroicons import Heroicon

Heroicon("academic-cap", style="color: red")

You can pass any valid heroicon icon name to Heroicon. A full searchable list of icons can be found here.

Caveat

This is very much wip as well as my first python library ever. So please treat it gently.

Currently only the outline versions of the icons are supported. Support for the solid variants coming soon.

License

The library is distributed under the MIT LICENSE.