Grace with Htmx

Grace Plugin for using Grace/Grails app with htmx.

Usage

Add dependency to the build.gradle,

repositories {
    mavenCentral()
}

dependencies {
    implementation "org.graceframework.plugins:htmx:VERSION"
}

Htmx plugin supports controller-specific withFormat() method,

class BookController {

    def list() {
        def books = Book.list()

        withFormat {
            htmx {
                render(template: "book", model: [bookList: books])
            }
            json {
                render books as JSON
            }
        }
    }
}

Also, this plugin supports extendsions for Grails Request and Response,

// You can get htmx request headers from Grails Request

request.htmx.boosted == request.getHeader('HX-Boosted')
request.htmx.target  == request.getHeader('HX-Target')

// Check htmx request?
if (request.htmx as boolean) { // or use request.isHtmx()
    template = 'book-detail'
}

// You can set htmx response headers in Grails

response.htmx.trigger = 'itemAdded'

If you use respond method introduced in Grails 2.3. The respond method tries to produce the most appropriate response for the requested content type (JSON, XML, HTML etc.)

For example given the show action:

def show(Book book) {
    respond book
}

You could supply a show.htmx.gsp file to render the HTMX:

<div id="${book.id}">
    <h1>${book.title}</h1>
    <p>${book.description}</p>
</div>

Example

• Grace Htmx TodoMVC

Development

Build from source

git clone https://github.com/grace-plugins/grace-htmx.git
cd grace-htmx
./gradlew publishToMavenLocal

Support Version

• Grace 2022.0.0+
• Grails 3.0+

Roadmap

1.x

• Htmx 1.9

2.x

• Htmx 2.0

License

This plugin is available as open source under the terms of the APACHE LICENSE, VERSION 2.0

Links

• Grace Website
• Grace Plugins
• Grace Htmx Plugin
• Grace Htmx TodoMVC
• Grails Htmx TodoMVC