slippers 0.1.3

Slippers is a lightweight library for Django that makes your HTML components available as template tags.

Slippers

Slippers is a lightweight library for Django that makes your HTML components available as template tags.

{% card variant="small" %}
  <h1>Slippers is cool</h1>

  {% button %}Super cool{% endbutton %}
  {% button variant="secondary" %}Lit af{% endbutton %}
{% endcard %}

Why?

I want to be able to make reusable components, but the syntax for {% include %} is too verbose. Plus it doesn't allow me to specify child elements.

Show me how it works

First create your template. Wherever you would normally put it is fine.

{# myapp/templates/myapp/card.html #}
<div class="card">
  <h1 class="card__header">{{ heading }}</h1>
  <div class="card__body">
    {# Child elements are rendered by `{{ children }}` #}
    {{ children }}
  </div>
</div>

Next, create a components.yaml file. By default, Slippers looks for this file in the root template folder.

# myapp/templates/components.yaml
# Components that have child elements
block_components:
  card: "myapp/card.html"
 
# Components that don't have child elements
inline_components: 
  avatar: "myapp/avatar.html"

You can now use the components like so:

{% load slippers %}

{% card heading="Slippers is awesome" %}
  <span>Hello {{ request.user.full_name }}!</span>
{% endcard %}

And the output:

<div class="card">
  <h1 class="card__header">Slippers is awesome</h1>
  <div class="card__body">
    <span>Hello Ryland Grace!</span>
  </div>
</div>

Installation

pip install slippers

Add it to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'slippers',
    ...
]

Documentation

The components.yaml file

This file should be placed at the root template directory. E.g. myapp/templates/components.yaml.

The structure of the file is as follows:

# Components that have child elements are called "block" components
block_components:
  # The key determines the name of the template tag. So `card` would generate
  # `{% card %}{% endcard %}`
  # The value is the path to the template file as it would be if used with {% include %}
  card: "myapp/card.html"
 
# Components that don't have child elements are called "inline" components
inline_components: 
  avatar: "myapp/avatar.html"

This file also doubles as an index of available components which is handy.

Context

Unlike {% include %}, using the component template tag will not pass the current context to the child component. This is a design decision. If you need something from the parent context, you have to explicitly pass it in via keyword arguments, or use {% include %} instead.

{% with not_passed_in="Lorem ipsum" %}
  {% button is_passed_in="Dolor amet" %}Hello{% endbutton %}
{% endwith %}

License

MIT