Skip to main content

Add Heroicons to your Wagtail site

Project description

Wagtail Heroicons

Add Heroicons 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 and PR #6028 in the Wagtail repository for more information.

Installation

Install the package using pip:

pip install wagtail-heroicons

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

INSTALLED_APPS = [
    ...
    'wagtail_heroicons',
]

Usage

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

For example, the solid Adjustments icon would be heroicons-adjustments-solid.

To see all available icons, names and styles, visit the Heroicons website.

See the Wagtail documentation for more information on using icons in Wagtail.

License

This package is licensed under the MIT License. See the LICENSE file for details.

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_heroicons-0.1.0.tar.gz (46.9 kB view hashes)

Uploaded source

Built Distribution

wagtail_heroicons-0.1.0-py3-none-any.whl (226.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page