django-iconify 0.4

安装

要将 django-iconify 添加到项目中，首先将其作为依赖项添加到项目中，例如使用 poetry

$ poetry add django-iconify

然后，将其添加到您的 INSTALLED_APPS 设置中，以便以后可以使用其视图

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

您需要通过某种方式使 JSON收藏集 可用。您可以手动下载它，或使用您喜欢的资产管理库。例如，您可以使用 django-yarnpkg 依赖 @iconify/json Yarn包

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

无论哪种方式，最后，您都必须在设置中配置收集集的路径

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

如果您不使用 django-yarnpkg，则手动构建路径或使用资产管理器提供的任何机制。

您可以使用两个设置来配置可用的图标收藏集

ICONIFY_COLLECTIONS_ALLOWED = ["foo", "bar"]

此列表控制哪些收藏集可以使用。如果设置为非空列表，则只允许列表中列出的收藏集。

ICONIFY_COLLECTIONS_DISALLOWED = ["foo", "bar"]

另一方面，此列表控制哪些收藏集不能使用。如果此列表包含值，而 COLLECTIONS_ALLOWED 没有设置，则允许所有列表中未列出的收藏集。

此允许/拒绝功能可用于仅因设计原则或法律原因应仅提供有限集合的情况。

最后，将URL包含在您的 urlpatterns 中

from django.urls import include, path

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

使用方法

<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 %}" />

示例

源代码分发以及 Git存储库 包含一个完整的应用程序示例，该应用程序在 /icons/ 下提供API，在 /test.html 下提供测试页面。

它被简化为一个最小的工作示例，以方便读者。