Planning to add HTMX support?

[danilommarano]

Currently is not possible to write elements with HTMX attributes. This is because every HTMX attribute uses the - character for namespacing, which is not accepted by Python as a variable character.

At HTMX docs there is the following button example:

<script src="https://unpkg.com/[email protected]"></script>
<!-- have a button POST a click via AJAX -->
<button hx-post="/clicked" hx-swap="outerHTML">
  Click Me
</button>

But when I tried to simulate it using _ as described in the SVG readme section it didn't work.

from dominate.tags import *
element = button(hx_post="/clicked", hx_swap="outerHTML")
print(element)
# <button hx_post="/clicked" hx_swap="outerHTML"></button>

[Knio]

See the docs for attribute setting here: https://github.com/Knio/dominate#attributes

[hasansezertasan]

This works:

from dominate.tags import *
element = button(**{"hx-post": "/clicked", "hx-swap": "outerHTML"})
print(element)
# <button hx_post="/clicked" hx_swap="outerHTML"></button>

You can create a Pydantic Model for HTMX attributes with aliases to achive a more beautiful syntax.

Like this:

from pydantic import BaseModel, Field
from dominate.tags import *

class HTMX(BaseModel):
    """HTMX attributes"""
    hx_post: str = Field(None, title="Post URL", serialization_alias="hx-post")
    hx_get: str = Field(None, title="Get URL", serialization_alias="hx-get")
    hx_swap: str = Field(None, title="Swap with", serialization_alias="hx-swap")

htmx_attrs = HTMX(hx_post="/clicked", hx_swap="outerHTML")
element = button(**htmx_attrs.model_dump(exclude_none=True))
print(element)

I don't know the every HTMX attributes there are but you can find more at htmx reference, this is just a sketch. Feel free to improve.

[williamw]

I haven't tried this out yet, but you should be able to use a context manager like this:

class HTMX(BaseModel):
    """HTMX attributes"""
    hx_post: str = Field(None, title="Post URL", serialization_alias="hx-post")
    hx_get: str = Field(None, title="Get URL", serialization_alias="hx-get")
    hx_swap: str = Field(None, title="Swap with", serialization_alias="hx-swap")

    def __enter__(self):
        self._attr = attr(**self.model_dump(exclude_none=True))
        self._attr.__enter__()

    def __exit__(self, exc_type, exc_value, traceback):
      self._attr.__exit__(exc_type, exc_value, traceback)

# Usage
doc = document()
with doc:
    with HTMX(hx_post="/clicked", hx_swap="outerHTML"):
        a('Click here', href="/posts")