Skip to main content

Icons for Django

Project description

django-icons

Tests Coverage Status Latest PyPI version

Icons for Django

  • Define your icons in your settings, with defaults for name, title and other attributes.
  • Generate icons using template tags.
  • Supports Font Awesome, Material, Bootstrap 3 and images.
  • Add other libraries and custom icon sets by subclassing IconRenderer.

More information

Installation

Install using pip.

pip install django-icons

In your settings.py, add django_icons to INSTALLED_APPS and define an icon.

INSTALLED_APPS = (
    # ...
    "django_icons",
    # ...
)

DJANGO_ICONS = {
    "ICONS": {
        "edit": {"name": "fa-solid fa-pencil"},
    },
}

Render an icon in a Django template.

{% 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' %}

This will generate the FontAwesome 6 pencil icon in regular style.

<i class="fa-solid fa-pencil"></i>

Add extra classes and attributes to your predefined icon.

{% load icons %}
{% icon 'edit' extra_classes='fa-2xs my-extra-class' title='Update' %}

These will be added to the HTML output.

<i class="fa-solid fa-pencil fa-2xs my-extra-class" title="Update"></i>

Requirements

This package requires a combination of Python and Django that is currently supported.

See "Supported Versions" on https://www.djangoproject.com/download/.

Local installation

Local installation

This package uses uv and just.

To clone the repository and install the requirements for local development:

git clone git://github.com/zostera/django-icons.git
cd django-icons
just bootstrap

Running the demo

You can run the example app:

just example

Running the tests

The test suite requires tox to be installed. Run the complete test suite like this:

tox

Test for the current environment can be run with the Django manage.py command.

just test

Origin

Our plans at Zostera for an icon tool originate in https://github.com/dyve/django-bootstrap3. We isolated this into a Font Awesome tool in https://github.com/zostera/django-fa. When using our own product, we felt that the icon tool provided little improvement over plain HTML. Also, Font Awesome's icon names did not match the intended function of the icon.

This is how we came to think of a library that:

  • Took a limited number of arguments
  • Converted those arguments into an icon
  • Was able to support multiple icon libraries
  • Could bind an icon definition to a preset name for easy reuse
  • Could easily be extended by users

This is how we came to write and use django-icons.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_icons-25.1.tar.gz (91.8 kB view details)

Uploaded Source

Built Distribution

django_icons-25.1-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file django_icons-25.1.tar.gz.

File metadata

  • Download URL: django_icons-25.1.tar.gz
  • Upload date:
  • Size: 91.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for django_icons-25.1.tar.gz
Algorithm Hash digest
SHA256 a95eefdc0e1c3a8193b40ca2228824e61ac7dffa37d27dcf7cf2efef9d180881
MD5 1eb9b62e363ce9e51185d069435f9957
BLAKE2b-256 722992c3670135078797aa9bc59f5af0b25386c777e1091e8827cd1357a3a9ed

See more details on using hashes here.

File details

Details for the file django_icons-25.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_icons-25.1-py3-none-any.whl
Algorithm Hash digest
SHA256 06a0a95af5f9d4f62929e1a6072b848d870c2e597a9139154cfb66458ed4114b
MD5 63d2f58bbff2f0d45fd43d367c7b054d
BLAKE2b-256 cb13a2a49d87ed62cc202784200c122b89b712e3f65def9854bce7b5442faa86

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page