Skip to content

twidi/django-templates-macros

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 <[email protected]> http://www.logix.cz/michal
    http://djangosnippets.org/snippets/363/

Extended for args and kwargs into templatetags/kwacro.py by
    Skylar Saveland <[email protected]> http://skyl.org
    https://gist.github.com/skyl/1715202

Modified to support rendering into context by [email protected]

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

About

Add macros to your django templates

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages