Django图标
项目描述
django-icons
Django图标
- 在您的设置中定义图标，包括名称、标题和其他属性。
- 使用模板标签生成图标。
- 支持Font Awesome、Material、Bootstrap 3和图像。
- 通过继承IconRenderer添加其他库和自定义图标集。
更多信息
安装
使用pip进行安装。
pip install django-icons
在您的 settings.py 中，将 django_icons 添加到 INSTALLED_APPS 并定义一个图标。
INSTALLED_APPS = (
# ...
"django_icons",
# ...
)
DJANGO_ICONS = {
"ICONS": {
"edit": {"name": "fa-solid fa-pencil"},
},
}
在Django模板中渲染一个图标。
{% load icons %}
<!-- Include your icon library. This example uses Font Awesome 6 through cdnjs. -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
{% icon 'edit' %}
这将生成常规样式的FontAwesome 6铅笔图标。
<i class="fa-solid fa-pencil"></i>
向您的预定义图标添加额外的类和属性。
{% load icons %}
{% icon 'edit' extra_classes='fa-2xs my-extra-class' title='Update' %}
这些将被添加到HTML输出中。
<i class="fa-solid fa-pencil fa-2xs my-extra-class" title="Update"></i>
要求
此包需要当前支持的Python和Django的组合。
请参阅https://django.ac.cn/download/上的“支持的版本”。
本地安装
本节假设您已了解本地Python版本和虚拟环境。
要克隆存储库并安装本地开发所需的要求
$ git clone git://github.com/zostera/django-icons.git
$ cd django-icons
$ pip install -e .
$ pip install -U pip -r requirements-dev.txt
运行演示
您可以运行示例应用程序
cd example && run python manage.py runserver
运行测试
测试套件需要安装tox。运行完整的测试套件如下
tox
可以使用Django的manage.py命令运行当前环境的测试。
python manage.py test
起源
佐斯特拉为图标工具制定的计划起源于https://github.com/dyve/django-bootstrap3。我们将此隔离为Font Awesome工具https://github.com/zostera/django-fa。在使用我们自己的产品时，我们发现图标工具在普通HTML上几乎没有改进。此外，Font Awesome的图标名称与图标的预期功能不匹配。
这就是我们想到一个库的原因
- 接受有限数量的参数
- 将这些参数转换为图标
- 能够支持多个图标库
- 能够将图标定义绑定到预定义名称以便于重复使用
- 用户可以轻松扩展
这就是我们编写并使用django-icons的原因。
下载文件
下载适用于您的平台文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分布
django_icons-24.4.tar.gz (30.8 kB 查看散列)
构建分布
django_icons-24.4-py3-none-any.whl (13.4 kB 查看散列)
关闭
django_icons-24.4.tar.gz的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | 8ae699e22cfc6a80a62eaa267a1d345f2c79adfa6f68f7f67a0316fefac977b3 |
|
| MD5 | a93b6adcaef4733a9b905db4144d6efe |
|
| BLAKE2b-256 | 36dac34386f12d2aed9e3b460a18b0003811e7c38e9cb0828ba90ac068ec079c |