Functions
hx_request
0
bool
▼
Check if current request is from HTMX.
Returns True if the framework has set t…
hx_request
0
bool
▼
def hx_request() -> bool
Check if current request is from HTMX.
Returns True if the framework has set the hx_request metadata flag, indicating this is an HTMX-initiated request rather than a full page load.
Usage: {% if hx_request() %} {# Partial render - just the updated component #} {% block content %}...{% end %} {% else %} {# Full page render #} {% extends "base.html" %} {% end %}
Framework Integration:
In your web framework (e.g., Chirp):
from kida.render_context import render_context
with render_context() as ctx:
# Detect HTMX via HX-Request header
is_htmx = request.headers.get("HX-Request") == "true"
ctx.set_meta("hx_request", is_htmx)
html = template.render(**data)
Returns
bool
hx_target
0
str | None
▼
Get HTMX target element ID.
Returns the value of the HX-Target header, which i…
hx_target
0
str | None
▼
def hx_target() -> str | None
Get HTMX target element ID.
Returns the value of the HX-Target header, which indicates which element HTMX will swap content into. Useful for conditional rendering based on which part of the page is being updated.
Usage: {% if hx_target() == "user-list" %} {# Render just the user list #}
-
{% for user in users %}
- {{ user.name }} {% end %}
Framework Integration: with render_context() as ctx: target = request.headers.get("HX-Target") ctx.set_meta("hx_target", target)
Returns
str | None
hx_trigger
0
str | None
▼
Get HTMX trigger element ID.
Returns the value of the HX-Trigger header, which…
hx_trigger
0
str | None
▼
def hx_trigger() -> str | None
Get HTMX trigger element ID.
Returns the value of the HX-Trigger header, which indicates which element triggered the HTMX request. Useful for tracking which button/link initiated an action.
Usage: {% if hx_trigger() == "delete-button" %}
Framework Integration: with render_context() as ctx: trigger = request.headers.get("HX-Trigger") ctx.set_meta("hx_trigger", trigger)
Returns
str | None
hx_boosted
0
bool
▼
Check if request is HTMX-boosted.
Returns True if the request came from an ele…
hx_boosted
0
bool
▼
def hx_boosted() -> bool
Check if request is HTMX-boosted.
Returns True if the request came from an element with hx-boost="true", which means HTMX is progressively enhancing a standard link/form to use AJAX instead of a full page load.
Usage: {% if hx_boosted() %} {# Enhanced navigation - smooth transition #}
Framework Integration: with render_context() as ctx: boosted = request.headers.get("HX-Boosted") == "true" ctx.set_meta("hx_boosted", boosted)
Returns
bool
csrf_token
0
Markup
▼
Generate CSRF token hidden input for forms.
Returns a hidden input field conta…
csrf_token
0
Markup
▼
def csrf_token() -> Markup
Generate CSRF token hidden input for forms.
Returns a hidden input field containing the CSRF token. The framework must set the token via RenderContext.set_meta("csrf_token", value).
Renders as:
Usage:
Returns
Markup