A quick way to add Bootstrap Icons with Django template tags.
Project description
django-bootstrap-icons
A quick way to add Bootstrap Icons with Django template tags.
Embed bootstrap svg icons in your django templates with the possibility for styling and sizing.
Installing
django-bootstrap-icons can be found on pypi. Run pip install django-bootstrap-icons
to install the package on your machine.
Getting Started
Using django-bootstrap-icons is easy. First, install the django_material_icons
Django app in your settings file.
INSTALLED_APPS = [
'django_bootstrap_icons'
]
Also, include the following tags in your base template file. It includes the CDN link to the bootstrap icons web font. If you have your own source for the web font, feel free to opt out of this tag!
{% load django_bootstrap_icons %}
Then, add an icon with the following tag. Give the name icon's name as the first parameter, and that's all that's required.
{% bs_icon_svg 'alarm' %}
Icon sizes
You can size the icons by setting the size parameter:
{% bs_icon_svg 'alarm' size='1.5rem' %}
Icon styling
Set the color of an icon by specifying the color parameter:
{% bs_icon_svg 'alarm' color='red' %}
For further styling, you can add extra css classes:
{% custom_svg 'your-custom-svg-name' %}
Custom icons
There's a template tag for your custom icons. Store the custom icons in some static directory. SET the BS_ICON_CUSTOM_PATH setting to point to that static directory.
{% bs_icon_svg 'alarm' extra_classes='your-class-name' %}
The custom template accepts the same parameter as the bootstrap icon template.
Configuration
You can specify the source from which the icons are loaded:
BS_ICONS_BASE_URL = 'https://cdn.jsdelivr.net/npm/bootstrap-icons@1.4.1/'
BS_ICONS_BASE_URL defaults to the latest boostrap-icons CDN that was available when releasing this package. Change the URL to use an older or newer one.
To add custom icons to your app you need to set the path where these can be found. The default setting is custom-icons, so you would add your icons to /your-app/static/custom-icons/.
BS_ICONS_CUSTOM_PATH = 'custom-icons'
Example App
There's an Example App that shows how django bootstrap icons work on GitHub
License
This project is licensed under the MIT License - see the LICENSE file for details
Acknowledgments
- Thanks to bootstrap Icons!
Releases
- django-bootstrap-icons 0.5.0 (April 2021): Refactor to use bootstrap svg icons from CDN
Migration
If you had installed an earlier version of this package, please remove the
{% include_bootstrap_icons %}
template tag, since this is no longer available.
Release history Release notifications | RSS feed
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-bootstrap-icons-0.5.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04e0c325909b10f3e8559384f609f21328205ff069170314016c3c52e82462b9 |
|
| MD5 | 7af0c00d7c12a51c3612b3d30eded795 |
|
| BLAKE2b-256 | 2f33829b406f3b1d4cfee09f0e05786c6cf4337d568ae7259285efcbdb484b49 |
Hashes for django_bootstrap_icons-0.5.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9bb76dd01b0c3cd824de7d89f806e041ef685b0aa9d8e15527d438b2d1bb4bf2 |
|
| MD5 | 5e50021182e2f9e9a5d9c0298f92c732 |
|
| BLAKE2b-256 | b290a82dc530011bb6265b2728ff5813cd885437b24fa68d20331e592b543de2 |
