tablericons2 1.0.0

Use Tabler Icons in your Django and Jinja templates.

tablericons

Use Tabler Icons in your Django and Jinja templates.

Requirements

Python from 3.10 supported.

Django from 5.2 supported.

Usage

The tablericons2 package supports both Django templates and Jinja templates. Follow the appropriate guide below.

Django templates

1. Install with python -m pip install tablericons2[django].

2. Add to your INSTALLED_APPS:

   INSTALLED_APPS = [
       ...,
       "tablericons",
       ...,
   ]
   

3. Now your templates can load the template library with:

       {% load tablericons %}
   

Alternatively, make the library available in all templates by adding it to the builtins option:

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

The library provides one tag (icon) to render SVG icons which can take these arguments:

• name, positional: the name of the icon to use. You can see the icon names on the tabler grid.

• size, keyword: an integer that will be used for the width and height attributes of the output <svg> tag. Defaults to the icons’ designed sizes, 24. It can also be None, in which case no width or height attributes will be output.

• Any number of keyword arguments. These will be added as attributes in the output HTML. Underscores in attribute names will be replaced with dashes, allowing you to define e.g. data- attributes.

Most attributes will be added to the <svg> tag containing the icon, but these attributes will be attached to the inner <path> tags instead:

• stroke-linecap
• stroke-linejoin
• vector-effect

Note: unlike the SVG code you can copy from tabler grid, there is no default class.

Examples

An "a-arrow-down” icon:

    {% icon "a-arrow-down" %}

The same icon at 40x40 pixels, and a CSS class:

    {% icon "a-arrow-down" size=40 class="mr-4" %}

That icon again, but with the paths changed to a narrower stroke width, and a "data-controller" attribute declared:

    {% icon "a-arrow-down" stroke_width=1 data_controller="language" %}

Jinja templates

1. Install with python -m pip install tablericons[jinja].

2. Adjust your Jinja Environment to add the global tablericons function from tablericons.jinja. For example:

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

3. Now in your templates you can call that function, which will render the corresponding <svg> icons. The function takes these arguments:

• name, positional: the name of the icon to use. You can see the icon names on the tabler grid

• size, keyword: an integer that will be used for the width and height attributes of the output <svg> tag. Defaults to the icons’ designed sizes, 24. Can be None, in which case no width or height attributes will be output.

• Any number of keyword arguments. These will be added as HTML attributes to the output HTML. Underscores in attribute names will be replaced with dashes, allowing you to define e.g. data- attributes.

Most attributes will be added to the <svg> tag containing the icon, but these attributes will be attached to the inner <path> tags instead:

• stroke-linecap
• stroke-linejoin
• vector-effect

Note: unlike the SVG code you can copy from tabler grid, there is no default class.

Examples

An "a-arrow-down” icon:

    {{ icon("a-arrow-down") }}

The same icon at 40x40 pixels and a CSS class:

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

That icon again, but with the paths changed to a narrower stroke width, and a "data-controller" attribute declared:

    {{ icon("a-arrow-down", stroke_width=1, data_controller="language") }}

Acknowledgements

This package is forked from franciscobmacedo/lucide which in turn is heavely inspired by Adam Johnson's heroicons.