django-iconify 0.1.0

Installation

To add django-iconify to a project, first add it as dependency to your project, e.g. using poetry:

$ poetry add django-iconify

Then, add it to your INSTALLED_APPS setting to make its views available later:

INSTALLED_APPS = [
    ...
    "dj_iconify.apps.DjIconifyConfig",
    ...
]

You need to make the JSON collection available by some means. You can download it manually, or use your favourite asset management library. For instance, you could use django-yarnpkg to depend on the @iconify/json Yarn package:

YARN_INSTALLED_APPS = [
  "@iconify/json",
]
NODE_MODULES_ROOT = os.path.join(BASE_DIR, "node_modules")

No matter which way, finally, you have to configure the path to the collections in your settings:

ICONIFY_JSON_ROOT = os.path.join(NODE_MODULES_ROOT, "@iconify", "json")

If you do not use django-yarnpkg, construct the path manually, ot use whatever mechanism your asset manager provides.

Finally, include the URLs in your urlpatterns:

from django.urls import include, path

urlpatterns = [
    path("icons/", include("dj_iconify.urls")),
]

Usage

<script type="text/javascript" src="{% url 'config.js' %}"></script>
<script type="text/javascript" src="https://code.iconify.design/1/1.0.6/iconify.min.js"></script>

<img src="{% url 'iconify_svg' 'mdi' 'account' %}?rotate=90deg %}" />

Example

The source distribution as well as the Git repository contain a full example application that serves the API under /icons/ and a test page under /test.html.

It is reduced to a minimal working example for the reader’s convenience.

Iconify: https://iconify.design/ django-iconify: https://edugit.org/AlekSIS/libs/django-iconify poetry: https://python-poetry.org/ JSON collection: https://github.com/iconify/collections-json django-yarnpkg: https://edugit.org/AlekSIS/libs/django-yarnpkg Iconify SVG Framework: https://docs.iconify.design/implementations/svg-framework/ How to use Iconify in CSS: https://docs.iconify.design/implementations/css.html Git repository: https://edugit.org/AlekSIS/libs/django-iconify