A utility for using icons in models, forms, and templates.
pipenv install django-fontawesome-5
Add 'fontawesome_5' to your installed INSTALLED_APPS:
INSTALLED_APPS = (
...
'fontawesome_5',
)
Import and use IconField:
from fontawesome_5.fields import IconField
class Category(models.Model):
...
icon = IconField()
Include Static Files
{% load fontawesome_5 %}
<head>
{% fontawesome_5_static %}
...
</head>
You can configure django-fontawesome to use another release/source/cdn by specifying::
FONTAWESOME_5_CSS = URL or None
default: 'fontawesome_5/css/django-fontawesome.css'
FONTAWESOME_5_CSS_ADMIN = URL or path
default: None
FONTAWESOME_5_ICON_CLASS = 'default' or 'semantic_ui'
default: 'default'
FONTAWESOME_5_PREFIX = 'custom_prefix'
default: 'fa'
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 %}
Or you can use the {% fa5_icon %} template tag.
{% fa5_icon 'check' 'fas' %}
Required positional arguments: icon, style_prefix
- class
extra custom classes - color
CSS Color Names - border
boolean - fixed_width
boolean - flip
horizontalvertical
- li
boolean - pull
leftright- pulse
boolean - rotate
integer - size
fa-xsfa-smfa-lgfa-2xfa-3xfa-5xfa-7xfa-10x
- spin
boolean - title
string
Or you can use the {% fa5_icon %} template tag.
{% fa5_icon 'check' %}
Required positional arguments: icon
- class
extra custom classes - bordered
boolean - circular
boolean - colored
Semantic UI Colors - disabled
boolean - fitted
boolean - flipped
horizontalvertical
- inverted
boolean - link
boolean - loading
boolean - rotated
clockwisecounterclockwise- pulse
boolean - rotate
integer - size
fa-xsfa-smfa-lgfa-2xfa-3xfa-5xfa-7xfa-10x
- title
string
Credit to https://github.com/redouane for the original ~
- Updated for use with Font Awesome 5
- Removed PyYAML, Select2, and jQuery as dependencies
- Static files tag includes static dependencies for use outside admin
- Moved rendering logic to renderers