Metadata-Version: 2.1
Name: wagtail-heroicons
Version: 0.1.3
Summary: Add Heroicons to your Wagtail site
Project-URL: Homepage, https://github.com/joshuadavidthomas/wagtail-heroicons
Project-URL: Issues, https://github.com/joshuadavidthomas/wagtail-heroicons/issues
Author-email: Josh Thomas <josh@joshthomas.dev>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 2
Classifier: Framework :: Wagtail :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7
Requires-Dist: wagtail>=2.15
Description-Content-Type: text/markdown

# Wagtail Heroicons

[![PyPI](https://img.shields.io/pypi/v/wagtail-heroicons)](https://pypi.org/project/wagtail-heroicons/) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/joshuadavidthomas/wagtail-heroicons/test.yml?branch=main)](https://github.com/joshuadavidthomas/wagtail-heroicons/actions/workflows/test.yml)

Add [Heroicons](https://heroicons.com/) to the Wagtail admin.

Note: SVG icons within the Wagtail admin are a relatively new feature in Wagtail, and the hook used within this package is not publically documented. As such, the API provided by Wagtail may change and cause breakage within this package. See Issue [#6107](https://github.com/wagtail/wagtail/issues/6107) and PR [#6028](https://github.com/wagtail/wagtail/pull/6028) in the Wagtail repository for more information.

## Installation

Install the package using pip:

```bash
pip install wagtail-heroicons
```

Add `wagtail_heroicons` to your `INSTALLED_APPS` setting in your `settings.py` file:

```python
INSTALLED_APPS = [
    ...
    'wagtail_heroicons',
]
```

## Usage

All icons follow the following naming convention: `heroicons-<name>-<style>`.

For example, the [solid Adjustments icon](https://heroicons.com/#adjustments-sm-btn) would be `heroicons-adjustments-solid`.

To see all available icons, names and styles, visit the [Heroicons website](https://heroicons.com/).

See the [Wagtail documentation](https://docs.wagtail.org/en/latest/search.html?q=icon) for more information on using icons in Wagtail.

## License

This package is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

Heroicons are licensed under the MIT License and are Copyright (c) 2020 Refactoring UI Inc.