FastAPIHTMX-HTMX Integration for FastAPI

Example

Using the `htmx()` decorator to specify a Jinja2 template for rendering a response, enabling partial page updates.

Scenario

In a customer management application, the `htmx()` decorator is used on an endpoint that returns a list of customers. When a user clicks a 'Load More' button, only the customer list part of the page is updated, improving the responsiveness of the application.

Example

Initializing FastAPI-HTMX with a Jinja2 template directory, enabling the application to locate and use templates for rendering.

Scenario

At the start of a project, `htmx_init()` is called with the template directory path. This setup allows all endpoints decorated with `htmx()` to automatically find and render the specified templates, streamlining the project setup and reducing repetitive code.

Example

Leveraging partial and full-page templates to provide single-page application (SPA) behaviors without the complexity of a full SPA framework.

Scenario

In an e-commerce site, product listings are dynamically loaded into the current page as the user scrolls, and product details can be fetched and displayed in a modal without navigating away from the page. This approach minimizes page loads and creates a seamless user experience.

Example

Adding custom Jinja2 filters for template rendering, enhancing the flexibility of data presentation.

Scenario

An application displaying a list of events allows dates to be formatted in a user-friendly manner using a custom `datetime_format` filter, making it easier for users to understand event timings.