Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.11 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.11 KB

django-faicon

Integrates a Font Awesome 5 icon picker in the Django admin interface. Picker interface includes dynamic search on the icon name & terms, filter by styles and can handle thousands of icons easily. Package uses the free version of Font Awesome but you can easily drop in the Pro version if you have license.

Admin Preview GIF

Documentation

Install

pip install django-faicon

Add faicon to INSTALLED_APPS in settings

Add path('faicon/', include('faicon.urls')), to urlpatterns in urls.py

Add the field to your model

from faicon.fields import FAIconField

class MyModel(models.Model):
    icon = FAIconField()

Setup

If you want to use Font Awesome Pro or a different version than the one included, download it and put it in your project static directory and name it fontawesome

To specify different locations for the icon files you can use these settings:

FAICON_YAML_FILE = 'fontawesome/metadata/icons.yml'
FAICON_CSS_URL = 'fontawesome/css/all.css'