Skip to main content

Add macros to your django templates

Project description

PyPI Version

django-templates-macros

Add macros to your django templates

Origin

The original code of this app is taken from https://djangosnippets.org/snippets/2892/ by MattP.

This snippets cites:

Based on snippet by
    Michal Ludvig <michal@logix.cz> http://www.logix.cz/michal
    http://djangosnippets.org/snippets/363/

Extended for args and kwargs into templatetags/kwacro.py by
    Skylar Saveland <michal@logix.cz> http://skyl.org
    https://gist.github.com/skyl/1715202

Modified to support rendering into context by matt@peloquin.com

Where

You can find this package here:

Usage

  1. Add this app “macros” to your INSTALLED_APPS

  2. In your template load the library:

    {% load macros %}
  3. Define a new macro called ‘my_macro’ that takes args and/or kwargs All will be optional:

    {% macro my_macro arg1 arg2 baz="Default baz" %}
        {% firstof arg1 "default_arg1" %}
        {% if arg2 %}{{ arg2 }}{% else %}default_arg2{% endif %}
        {{ baz }}
    {% endmacro %}
  4. Use the macro with string parameters or context variables:

    {% usemacro my_macro "foo" "bar" baz="KW" %}
    <br>
    {% usemacro my_macro num_pages "bar" %}

Renders like:

foo bar KW
77 bar Default baz
  1. Alternatively save your macros in a separate file, e.g. “mymacro.html” and load it to the current template with:

        {% loadmacros "mymacros.html" %}
    
    Then use these loaded macros in as described above.

Bear in mind that defined and loaded macros are local to each template file and are not inherited through {% extends … %} tags.

  1. When recursive macros are needed, use the ‘recurse_macro’ template tag:

    {% macro MENU entries %}
    <ul>
        {% for entry in entries %}
        <li>
            <a href="{{ entry.link }}"> {{ entry.label }} </a>
            {% if entry.children %}
                {% recurse_macro MENU entry.children %}
            {% endif %}
        </li>
        {% endfor %}
    </ul>
    {% endmacro %}
    {% usemacro MENU menu.children %}

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-templates-macros-0.3.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

django_templates_macros-0.3-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file django-templates-macros-0.3.tar.gz.

File metadata

  • Download URL: django-templates-macros-0.3.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for django-templates-macros-0.3.tar.gz
Algorithm Hash digest
SHA256 d67e05b014201b8512eec2e106a9341a49e7691b7b83e6679b40ee9630a2e80e
MD5 72f4026561fe90b3bdb82b51ae877e1e
BLAKE2b-256 c75c41cfe5b1a49df4f9b64fb9ca9aac4362faa079665af5bfaf399985f09eac

See more details on using hashes here.

File details

Details for the file django_templates_macros-0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for django_templates_macros-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 aadee18b13086c98860a870716f4c0b134eeadb4f89f626ef074e1872ff41ea7
MD5 fd08b9fdc66f6328212b03c1b2c0934a
BLAKE2b-256 d9a6248cc57d4717e2bf9c9ff36d745a14da7d42d16099a60d22a590c2552607

See more details on using hashes here.

Supported by

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