A simple django templatetag plugin for rendering and manipulating SVGs
Project description
Django-svg-clip
Django-svg-clip is a django template tags plugin for manipulating and rendering of svg and its attributes.
Features
- Adding static and dynamic attributes to svg icons.
- You don't have to paste the whole svg tag to add atrributes such as classes, inline-styles, WAI-arias.
- Makes the template look cleaner and shorter.
- Increases the readability.
Installation
Install django-svg-clip from PyPI by running:
# shell
pip install django-svg-clip
Setup
- After installing add
svg_cliptoINSTALLED_APPSin theDJANGO_SETTINGS_MODULE(e.g. settings.py).
# settings.py
INSTALLED_APPS = [
# ...
'svg_clip',
]
- Add SVG icons path to
SVG_ICONS_DIRS:
# settings.py
SVG_ICONS_DIRS = [
# path/to/icons
# E.g:
BASE_DIR / "static" / "heroicons" / "outline",
BASE_DIR / "static/heroicons/solid",
BASE_DIR / "static" / "icons",
BASE_DIR / "static/icons",
]
- Or you can use default icons by setting
USE_CLIP_ICONStoTrue.
# settings.py
USE_CLIP_ICONS = True
Usage
After adding the path of icons, use this tag {% clip 'icon-name' keyword_attrs="key word attrs" "non-keyword" "attrs" %} to add the icons to the django template.
NOTE: Don't put .svg extension to the icons, it is automatically added during compilation.
<!-- template.html -->
<!DOCTYPE html>
{% load svg_clip %}
<html>
<head>
<!-- ... -->
</head>
<body>
<!-- ... -->
{% clip 'academic-cap' %}
{% clip 'academic-cap' class="h-6 w-6" %}
{% clip 'academic-cap-solid' class="h-6 w-6" styles="display: block" %}
{% clip 'academic-cap' class="h-6 w-6" styles="display: block" "hidden" %}
</body>
</html>
Remarks: The defult icon set is heroicons-v2.0.13. To use the outline version, just use the icon name and for solid version, add '-solid' suffix to the icon name. For example, to use 'academic-cap.svg' outline version, just use 'academic-cap' and for solid version use 'academic-cap-solid'.
Development
- Issue Tracker: Github Issues
- Source Code: Github repo
NOTE: For contributing read the CONTRIBUTING.md file.
Support
If you are having issues, please let us know by opening an issue in our github repo. We warmly welcome you for any suggestion.
License
The project is licensed under the MIT license giving the community maximum priviledge to use. For more read LICENSE.md file.
Author
Name: Dayal Moirangthem
Twitter: @thisisdayal
Acknowledgement and credits
Heroicons: By default, we use icon set provided by heroicons with a minimal tweaks in icon names. For example, let us say academic-cap.svg. For outline version, there is no modification but for solid, you should use academic-cap-solid.svg.This is done to avoid name conflicts with outline and solid versions.
We'd like to show our regards to tailwindlabs team for availing those icons to community with an open source license.
Python project template: We use rochacbruno's python project template with little modification. It saves us a lot of time and headache during initial setup.
MIT License
Copyright (c) 2023 Dayal Moirangthem
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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_svg_clip-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d5c3f6b11be2f8ffb56ebd598167cccba80edbf667c2ce9300b87fbc7a901be1 |
|
| MD5 | 78682888d9062a34d47ca2f43737bfd6 |
|
| BLAKE2b-256 | 05a918d873576afbdf425cde72e8bff7c8da95ed1762a9b316b7c21cf986f536 |
