Requests

is_htmx_request

is_htmx_request(hx_request=Header(default=None))

Dependency injection function used to determine if request is coming from HTMX. Checks if 'hx-request' header is in the HTTP request.

Returns:

Name	Type	Description
bool	bool	Whether or not a request is coming from an HTMX action.

Example:

import air

app = air.App()

@app.get("/")
def index(is_htmx: bool = Depends(air.is_htmx_request)):
    return air.H1(f"Is HTMX request: {is_htmx}")

Source code in src/air/requests.py

def is_htmx_request(hx_request: str = Header(default=None)) -> bool:
    """Dependency injection function used to determine if request is coming from HTMX. Checks if 'hx-request' header is in the HTTP request.

    Returns:
        bool: Whether or not a request is coming from an HTMX action.

    Example:

        import air

        app = air.App()

        @app.get("/")
        def index(is_htmx: bool = Depends(air.is_htmx_request)):
            return air.H1(f"Is HTMX request: {is_htmx}")
    """
    return hx_request is not None and hx_request.lower() == "true"