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.10.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.10.0
File Size Uploaded Provenance Actions
plain_elements-0.10.0.tar.gz 6.2 kB Without provenance Details for plain_elements-0.10.0.tar.gz

Built distribution (wheel)

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

Total release size: 13.7 kB

Release files / plain_elements-0.10.0.tar.gz

Download URL plain_elements-0.10.0.tar.gz
Size 6.2 kB
Tags Source
SHA-256 checksum
How to use checksums
9779f6367a8ee14b64b4f1e61c453295d5a1d04791fae9ebf8a39aef8e6a47a9
BLAKE2b-256 checksum
How to use checksums
34ccb090e6b61c85a9ac083d20942ffba439655e1554e1f5f2602fe7c74c3755
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.18

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

Download URL plain_elements-0.10.0-py3-none-any.whl
Size 7.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2634a88a9e669350ba6ad3cfe7eacfa63bb92ee1214bfa20afa70819608fe6e9
BLAKE2b-256 checksum
How to use checksums
99a76c09c235a330b99fa6e9de155aadc1b463e1d8094bf4a55f8d9eaf047dc0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.18

Security for plain.elements 0.10.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