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.
This package contains Bootstrap Icons v1.2.2 (Jan 2021).
The icons are embedded from the icon font. If you'd rather like to use the svg images try this one: django_bs_icons.
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 %}
{% include_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.
{% load django_bootstrap_icons %}
{% bs_icon 'alarm' %}
Icon styling
To style the icons, you can add extra css classes:
{% bs_icon 'alarm' extra_classes='your-class-name' %}
Sizing classes are included in the bootstrap icon css:
{% bs_icon 'alarm' extra_classes='bi-xs' %}
{% bs_icon 'alarm' extra_classes='bi-sm' %}
{% bs_icon 'alarm' extra_classes='bi-2x' %}
{% bs_icon 'alarm' extra_classes='bi-3x' %}
{% bs_icon 'alarm' extra_classes='bi-5x' %}
{% bs_icon 'alarm' extra_classes='bi-7x' %}
{% bs_icon 'alarm' extra_classes='bi-10x' %}
If you have bootstrap css included, you can use the bootstrap color classes:
{% bs_icon 'alarm' extra_classes='text-success' %}
{% bs_icon 'alarm' extra_classes='text-info' %}
{% bs_icon 'alarm' extra_classes='text-warning' %}
{% bs_icon 'alarm' extra_classes='text-danger' %}
{% bs_icon 'alarm' extra_classes='text-primary' %}
{% bs_icon 'alarm' extra_classes='text-secondary' %}
License
This project is licensed under the MIT License - see the LICENSE file for details
Acknowledgments
- Thanks bootstrap Icons!
- Thanks to Doug Dresser dwdresser for the django_material_icon app that i used as a template
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.2.5.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d7d262f9cbb6cb349bed7d1440dc7057e710e16e2458c079886f247bf1699874 |
|
| MD5 | c82e2971f333d418a9a7062863ccb6f0 |
|
| BLAKE2b-256 | 4dc8241244b9fe4cb431ae7f1835a6989c56962a9453b5a376b5b2e8ef88062c |
Hashes for django_bootstrap_icons-0.2.5-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2710bd41bf7d82be753dfb6f2b8644a46e816f7bba0247e6385600a1dccaba06 |
|
| MD5 | a7e232701ed2576fb756314adcc28518 |
|
| BLAKE2b-256 | e31d6b5c3538a3c0ca0adae233fd99cc0cc076f4b326c559070b2a41248b333b |
