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.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| plain_elements-0.10.1.tar.gz | 6.5 kB | Without provenance | Details for plain_elements-0.10.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| plain_elements-0.10.1-py3-none-any.whl | Python 3 | none | any | Details for plain_elements-0.10.1-py3-none-any.whl |
Total release size: 14.1 kB
Release files / plain_elements-0.10.1.tar.gz
| Download URL | plain_elements-0.10.1.tar.gz |
|---|---|
| Size | 6.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
361094bc8937b8ab8888c144df1ae509bdc8fc9d78e2c0419c9ae04a7a8a5686
|
|
BLAKE2b-256 checksum How to use checksums |
7a139e0098b197ad462946fa3a29f4c89307042bf7a3e78dba4c06c5ded7a034
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.8.23
|
Release files / plain_elements-0.10.1-py3-none-any.whl
| Download URL | plain_elements-0.10.1-py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4f6d6ca90cdae9958d388cc028f9ad0886a224addea7c84f814d76504d6a25eb
|
|
BLAKE2b-256 checksum How to use checksums |
cc8276a55c13daa5a95d9788fa343cb612f8a0e282e74d08757b4d3877c8c432
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.8.23
|
Security for plain.elements 0.10.1
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.