Use the tabler icon set in your Django project.
Install the package from PyPI:
python -m pip install django-tabler-icons
Add tabler_icons
to your INSTALLED_APPS
:
INSTALLED_APPS = [
...
'tabler_icons',
...
]
Download the icon set:
python manage.py download_icons
Icons will be downloaded to <user_home_directory>/.config/django-tabler-icons
. You can override this by setting the TABLER_ICONS_DIR
setting, in project settings. This command requires to load Django.
Icons can also be downloaded without loading Django using:
django_tabler_icons download
which will download the icon set to <user_home_directory>/.config/django-tabler-icons
. This requires user confirmation to proceed. By passing --yes
or -y
as an argument, the confirmation is skipped.
To add an icon to your template, use the tabler_icon
template tag:
{% load tabler_icons %}
{% tabler_icon '<icon_name>' %}
If you need to add classes to the icon, use the second argument:
{% tabler_icon '<icon_name>' '<class_name_1> <class_name_2>' %}
The icons come with some default classes which you can remove by passing no
to the third argument (keep_default_classes
)
{% tabler_icon '<icon_name>' '<class_name_1> <class_name_2>' 'no' %}
The default is to keep the default classes so you can omit the third argument if you want to keep them.
Heroicons is a package for using heroicons in Django projects, which is also the inspiration for this package.