Use tabler icons with django templates
Project description
Django tabler icons
Use the tabler icon set in your Django project.
Installation
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.
Alternative download method
Calling the management command python manage.py download_icons
requires to load Django. To avoid this, the icons can be downloaded 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.
Usage
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.
Relevant projects
Heroicons is a package for using heroicons in Django projects, which is also the inspiration for this package.
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
Built Distribution
Hashes for django_tabler_icons-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 780c4365bd3f9d78de0893306413905b0319696a53158da87c491a3c57360136 |
|
MD5 | cc390feeeb99c4e7a8e716b5ea89aab8 |
|
BLAKE2b-256 | dfffac9b14b07d060320df60a8555609d39895f6198a638a18c6e60fc9a516f4 |
Hashes for django_tabler_icons-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92c81ba34213391ab4841bec4c3ac99caabd110f49148b2778030e44781db9b6 |
|
MD5 | d4f4f1543e0e48f8de750c7f2e0427c8 |
|
BLAKE2b-256 | 828dee719d35d9d121190db7bd696e410e60ace77f531116e7b29c75b26b8414 |