Or you can register the HTMX object using HTMX.init_app() <https://flask-htmx.readthedocs.io/en/latest/flask_htmx.htmx.html#flask_htmx.htmx.HTMX.init_app>_.

.. code-block:: python

htmx = HTMX()
htmx.init_app(app)

A minimal working example.

.. code-block:: python

from flask import Flask, render_template
from flask_htmx import HTMX

app = Flask(__name__)
htmx = HTMX(app)

@app.route("/")
def home():
    if htmx:
        return render_template("partials/thing.html")
    return render_template("index.html")

The above example checks whether the request came from HTMX or not. If :code:htmx evaluates to True <https://docs.python.org/3/library/constants.html#True>, then it was a HTMX request, else False <https://docs.python.org/3/library/constants.html#False>.

This allows you to return a partial HTML when it's a HTMX request or the full page HTML when it is a normal browser request.

Flask-HTMX also supports checking for HTMX headers during a request in the view. For example, check the current URL of the browser of a HTMX request.

.. code-block:: python

@app.route("/")
def home():
    current_url = htmx.current_url
    return render_template("index.html", current_url=current_url)

Other HTMX request headers are also available. See https://htmx.org/reference/#request_headers.

HTMX Response

You might be interested on adding htmx response headers <https://htmx.org/reference/#response_headers>_ to your response. Use :code:flask_htmx.make_response for that. For example, instead of:

.. code-block:: python

import json
from flask import make_response
from my_app import app

@app.route("/hola-mundo")
def hola_mundo():
    body = "Hola Mundo!"
    response = make_response(body)
    response.headers["HX-Push-URL"] = "false"
    trigger_string = json.dumps({"event1":"A message", "event2":"Another message"})
    response.headers["HX-Trigger"] = trigger_string
    return response

You can do:

.. code-block:: python

from flask_htmx import make_response
from my_app import app

@app.route("/hola-mundo")
def hola_mundo():
    body = "Hola Mundo!"
    return make_response(
        body,
        push_url=False,
        trigger={"event1": "A message", "event2": "Another message"},
    )

.. quickstart-endblock

Documentation

Visit the full documentation <https://flask-htmx.readthedocs.io>_.

Development

Installation

.. code-block:: bash

poetry install

Running tests

.. code-block:: bash

poetry run pytest

Coverage

.. code-block:: bash

poetry run pytest --cov=flask_htmx tests/

Docs

.. code-block:: bash

sphinx-autobuild docs docs/_build/html

Keywords

FAQs

What is flask-htmx?

Is flask-htmx well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install