# django-icons-bootstrap-icons
This project provides a renderer for [Bootstrap Icons](https://icons.getbootstrap.com) utilizing [django-icons](https://django-icons.readthedocs.io/en/latest/index.html).
## Installation
[PyPI](https://pypi.org/project/django-icons-bootstrap-icons/)
Just run:
```
pip install django-icons-bootstrap-icons
```
## To use
In your settings.py file:
```py
DJANGO_ICONS = {
"DEFAULT": {
"renderer": "django_icons_bootstrap_icons.BootstrapIconRenderer"
}
}
```
Then just use the `{% icon %}` tag as normal!
## Extra features
This renderer includes a very neat feature over the default `IconRenderer`, which is support for custom attributes.
For instance, to add an aria-label to your icon, you can do the following:
`{% icon "person" aria_label="person icon" %}`
Note that while attributes in HTML are `-`, separated, this isn't possible in Django templates due to Python. Therefore, write the keys with `_` instead, and the renderer will autoconvert them for you.
This also works with attributes that do not have `-`es in them, such as `tabindex`.
Aside from this, `BootstrapIconRenderer` supports all features of the default renderer as it is just a superclass of `IconRenderer`.
## Contributing
I welcome all contributions! Just fork and then send a PR.
## License
This work is licensed under the MIT license.
Raw data
{
"_id": null,
"home_page": null,
"name": "django-icons-bootstrap-icons",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Pyrox/dish <pyrox@pyrox.dev>",
"keywords": "bootstrap, bootstrap-icons, django, django-icons, icons",
"author": null,
"author_email": "Pyrox/dish <pyrox@pyrox.dev>",
"download_url": "https://files.pythonhosted.org/packages/06/b9/59373d8d6b35f3b44f54fd10bc7b140d14db58da66f1f30944829acff500/django_icons_bootstrap_icons-1.0.1.tar.gz",
"platform": null,
"description": "# django-icons-bootstrap-icons\n\nThis project provides a renderer for [Bootstrap Icons](https://icons.getbootstrap.com) utilizing [django-icons](https://django-icons.readthedocs.io/en/latest/index.html).\n\n## Installation\n\n[PyPI](https://pypi.org/project/django-icons-bootstrap-icons/)\n\nJust run:\n\n```\npip install django-icons-bootstrap-icons\n```\n\n## To use\n\nIn your settings.py file:\n\n```py\n\nDJANGO_ICONS = {\n \"DEFAULT\": {\n \"renderer\": \"django_icons_bootstrap_icons.BootstrapIconRenderer\"\n }\n}\n```\n\nThen just use the `{% icon %}` tag as normal!\n\n## Extra features\n\nThis renderer includes a very neat feature over the default `IconRenderer`, which is support for custom attributes.\n\nFor instance, to add an aria-label to your icon, you can do the following:\n\n`{% icon \"person\" aria_label=\"person icon\" %}`\n\nNote that while attributes in HTML are `-`, separated, this isn't possible in Django templates due to Python. Therefore, write the keys with `_` instead, and the renderer will autoconvert them for you.\n\nThis also works with attributes that do not have `-`es in them, such as `tabindex`.\n\nAside from this, `BootstrapIconRenderer` supports all features of the default renderer as it is just a superclass of `IconRenderer`.\n\n## Contributing\n\nI welcome all contributions! Just fork and then send a PR.\n\n## License\n\nThis work is licensed under the MIT license.\n",
"bugtrack_url": null,
"license": null,
"summary": "Bootstrap Icons renderer for django-icons",
"version": "1.0.1",
"project_urls": {
"Changelog": "https://github.com/pyrox0/django-icons-bootstrap-icons/releases",
"Issues": "https://github.com/pyrox0/django-icons-bootstrap-icons/issues",
"Repository": "https://github.com/pyrox0/django-icons-bootstrap-icons"
},
"split_keywords": [
"bootstrap",
" bootstrap-icons",
" django",
" django-icons",
" icons"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06afeb41273b1e9abd431113aedfddefdbbbf9945fa9a13ed07a368618c94c22",
"md5": "fa74c2ce123d5457d15445360f82d988",
"sha256": "7423689bc4c7c820dc2f85e7c9c0a5528feedcf636620eeb5eb9a801f4af8287"
},
"downloads": -1,
"filename": "django_icons_bootstrap_icons-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa74c2ce123d5457d15445360f82d988",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3307,
"upload_time": "2024-10-05T22:06:32",
"upload_time_iso_8601": "2024-10-05T22:06:32.729583Z",
"url": "https://files.pythonhosted.org/packages/06/af/eb41273b1e9abd431113aedfddefdbbbf9945fa9a13ed07a368618c94c22/django_icons_bootstrap_icons-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06b959373d8d6b35f3b44f54fd10bc7b140d14db58da66f1f30944829acff500",
"md5": "d2e0775dab7dbb2b7435ff6e989ecdb2",
"sha256": "10db76b6756e7eac9ddd857f3af3c66f9779856e255cb2dc9d2871f3568a0c14"
},
"downloads": -1,
"filename": "django_icons_bootstrap_icons-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d2e0775dab7dbb2b7435ff6e989ecdb2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14314,
"upload_time": "2024-10-05T22:08:54",
"upload_time_iso_8601": "2024-10-05T22:08:54.887986Z",
"url": "https://files.pythonhosted.org/packages/06/b9/59373d8d6b35f3b44f54fd10bc7b140d14db58da66f1f30944829acff500/django_icons_bootstrap_icons-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-05 22:08:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyrox0",
"github_project": "django-icons-bootstrap-icons",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "django-icons-bootstrap-icons"
}
JSON
