Skip to main content

plain.elements

Use HTML tags to include HTML template components.

Overview

Elements are an alternative to Jinja {% include %} or macros and flow better with existing HTML by using a compatible syntax. They are distinguished from built-in HTML tags by using a capitalized tag name (so <Button> doesn't clash with <button>).

To make a <Submit> element, for example, you would create a template named templates/elements/Submit.html.

<!-- templates/elements/Submit.html -->
<button type="submit" class="btn">
    {{ children }}
</button>

An element can be used in any other template by enabling them with {% use_elements %} and then using the capitalized tag name.

{% extends "admin/base.html" %}

{% use_elements %}

{% block content %}
<form method="post">
    <!-- Form fields here -->
    <Submit>Save</Submit>
</form>
{% endblock %}

Element attributes

Attributes will be passed through using regular strings or single braces {} for Python variables.

{% extends "admin/base.html" %}

{% use_elements %}

{% block content %}
<form method="post">
    <FormInput field={form.username} placeholder="Username" label="Username" />
    <Submit>Save</Submit>
</form>
{% endblock %}

The attributes are passed to the element as named variables. By default in Plain, you will get an error if you try to use an undefined variable, so Jinja features like |default and is defined are useful for optional attributes.

<!-- templates/elements/FormInput.html -->
<label for="{{ field.html_id }}">
    {{ label }}
</label>
<input
    id="{{ field.html_id }}"
    type="{{ type|default('text') }}"
    name="{{ field.html_name }}"
    value="{{ field.value() or '' }}"
    placeholder="{{ placeholder }}"
    {% if field.field.required %}required{% endif %}
    />

Namespaced elements

Especially for reusable packages, it can be useful to namespace your elements by putting them in a subdirectory of templates/elements/. To use namespaced elements, you need to include the full dot-separated path in your HTML tag.

For example, an element in templates/elements/admin/Submit.html would be used like this:

{% use_elements %}

{% block content %}
<form method="post">
    <admin.Submit>Save</admin.Submit>
</form>
{% endblock %}

Installation

Install the plain.elements package from PyPI:

uv add plain.elements

Add it to your INSTALLED_PACKAGES setting. That's it! The Jinja extension will be enabled automatically.

# settings.py
INSTALLED_PACKAGES = [
    # ...
    "plain.elements",
]

Metadata

Release files for plain.elements 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for plain.elements 0.9.0
File Size Uploaded Provenance Actions
plain_elements-0.9.0.tar.gz 6.1 kB Without provenance Details for plain_elements-0.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for plain.elements 0.9.0
File Interpreter ABI Platform Actions
plain_elements-0.9.0-py3-none-any.whl Python 3 none any Details for plain_elements-0.9.0-py3-none-any.whl

Total release size: 13.5 kB

Release files / plain_elements-0.9.0.tar.gz

Download URL plain_elements-0.9.0.tar.gz
Size 6.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1972cdd7d255db2db10a886b446e764c65e50e0e8288efd2742a3e8f39be0072
BLAKE2b-256 checksum
How to use checksums
4bd246d376fe8b1774e33a3150dfd3ff9149c0612795dd568fe48a80cab484dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.12

Release files / plain_elements-0.9.0-py3-none-any.whl

Download URL plain_elements-0.9.0-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4c83a84f64e5a98b6e2b8fbdb6b3e69c19fae91eefe107853e8b88363706d1d3
BLAKE2b-256 checksum
How to use checksums
adc066fecfd72bcdb86d1b1ff7902556f9f3ee76db0a2716453af8d3dee7272c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.12

Security for plain.elements 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page