A simple Tag ({% icon "name" %}) to implement Feather Icons in Django.
Install django-feather using pip and put it into your INSTALLED_APPS:
pip install django-feathersettings.py:
INSTALLED_APPS = [
# ...
'django_feather',
# ...
]After installation, the tag can be used just like any other tag:
{% load icon %}
<p>Using a string {% icon "coffee" class="css-class" height="8" width="8" %}</p>
<p>Using a variable {% icon icon_name class="css-class" height="8" width="8" %}</p>The icon tag will simply take the SVG source from the Feather project,
apply additional attributes and return the SVG tag.
Additionally, data URIs are supported by setting data_uri=True. This
will yield a Base64 encoded data URI that can be used e.g. in src
attributes or with CSS:
<img src="{% icon icon_name data_uri=True %}">There are a few tests in the tests directory that should test the
basic functions of this module. However, as these tests require the
package to be build (so that the django_feather.icons module is
populated), there are a few important steps to testing:
# Start by building the project
python setup.py build
# There should now be a build/lib directory present
# Make sure that django, pytest and pytest-django are installed:
pip install django pytest pytest-django
# Run the tests
export DJANGO_SETTINGS_MODULE=tests.settings
PYTHONPATH=build/lib:./ pytest tests The environment variable PYTHONPATH ensures that django_feather is
not imported from the current directory but rather from the build/lib
directory.
django-feather does not read the .svg files each time an icon is rendered.
Instead, all the icons are written to a .py file upon build, just like the JavaScript
library.
However, other than the JavaScript library, icons are rendered on the server side.
This avoids having to call feather.replace() after the page has loaded.
Feather is licensed under the MIT License.
django-feather is licensed under the Apache License, Version 2.0:
Copyright 2019-2021 Jonas Drotleff <[email protected]>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent