django-lucide 1.3.0

Use lucide in your Django and Jinja templates.

lucide

Use Lucide icons in your Django and Jinja templates.

Fork of franciscobmacedo/lucide with additional features:

• Dynamic template attribute rendering (use {{ variables }} in attributes)
• Icon alias support with deprecation warnings (246 aliases)
• Automatic icon updates via GitHub Actions

Requirements

Python 3.8 to 3.12 supported.

Django 3.2 to 5.0 supported.

Installation

pip install django-lucide

Usage

The lucide package supports both Django templates and Jinja templates.

Django templates

1. Add to your INSTALLED_APPS:

   INSTALLED_APPS = [
       ...,
       "lucide",
       ...,
   ]
   

2. Load the template library in your templates:

   {% load lucide %}
   

   Or make it available globally (no {% load %} needed):

   TEMPLATES = [
       {
           "BACKEND": "django.template.backends.django.DjangoTemplates",
           # ...
           "OPTIONS": {
               # ...
               "builtins": [
                   "lucide.templatetags.lucide",
               ],
           },
       }
   ]
   

3. Use icons:

   {% lucide "arrow-down" %}
   {% lucide "arrow-down" size=40 class="mr-4" %}
   {% lucide "arrow-down" stroke_width=1 data_controller="icon" %}
   

Dynamic attributes

You can use template variables in attributes:

{% lucide "user" class="{{ css_class }}" data-id="{{ user.id }}" %}

Icon aliases

Old icon names automatically resolve to new names with a deprecation warning:

{% lucide "edit-2" %}  {# Works, but warns to use "pen" instead #}

Jinja templates

1. Add the global function to your environment:

   from lucide.jinja import lucide
   from jinja2 import Environment
   
   env = Environment()
   env.globals.update({"lucide": lucide})
   

2. Use icons:

   {{ lucide("arrow-down") }}
   {{ lucide("arrow-down", size=40, class="mr-4") }}
   

Icon reference

Browse all available icons at lucide.dev/icons.

Acknowledgements

• Original package by franciscobmacedo
• Inspired by Adam Johnson's heroicons