Metadata-Version: 2.4
Name: fh-heroicons
Version: 0.1.0
Summary: FastHTML package for Heroicons
Project-URL: Homepage, https://github.com/vacmar01/fh-heroicons
Project-URL: Repository, https://github.com/vacmar01/fh-heroicons
Project-URL: Issues, https://github.com/vacmar01/fh-heroicons/issues
Author-email: Marius <mariusvach@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: fasthtml,heroicons,icons,svg
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4>=4.12.3
Requires-Dist: httpx>=0.27.2
Requires-Dist: lxml>=5.3.0
Requires-Dist: python-fasthtml>=0.10.1
Description-Content-Type: text/markdown

# fh-heroicons

Any use of the code retrieved from [heroicons.com](https://heroicons.com/) is subject to the terms of the Heroicons license, found [here](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE).

-----

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

```bash
pip install fh-heroicons
```

## Usage

```python
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](https://heroicons.com/).

You can also specify which variant of the icons (`outline` or `solid`, default to `outline`) you want by adding the `variant` attribute to `Heroicon`. 

```python
Heroicon("academic-cap", variant="solid")
```

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

## License

The library is distributed under the MIT LICENSE.