Skip to main content

A utility for using icons in models and forms.

Project description

django-font-icons

A utility for using icons in models and forms. You can also disable icons so they will no show in the select.

It uses selectr for filtering of the icons.

Installation / Usage

pip install django-font-icons

Add 'font_icons' to your installed INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'font_icons',
)

Import and use IconForeignKeyField:

from font_icons.models import IconForeignKeyField

class Category(models.Model):
    ...
    icon = IconForeignKeyField()

Add Fontawesome js and/or css yourself. We do not provide a default version.

admin/base_site.html

{% block extrastyle %}
    {{ block.super }}
    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
    <link href="https://unpkg.com/mobius1-selectr@latest/dist/selectr.min.css" rel="stylesheet" type="text/css">
    <script src="https://unpkg.com/mobius1-selectr@latest/dist/selectr.min.js" type="text/javascript"></script>
{% endblock %}

Rendering

You can do a simple render in your template like this:

{% for category in categories.all %}
    {% if category.icon %}
        {{ category.icon.as_html }}
    {% endif %}
{% endfor %}

Changes

  • Add the fontawesome 5 Free icons. (manage.py loadfontawesome5_free)
  • Support for fontawesome 5 Pro and fontawesome 4.7 (No management command to load all the icons yet.)

Project details


Download files

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

Source Distribution

django-font-icons-1.0.1.tar.gz (14.8 kB view hashes)

Uploaded Source

Built Distribution

django_font_icons-1.0.1-py3-none-any.whl (17.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page