Add ability to render thymeleaf fragments #678

johannesg · 2023-12-19T21:42:01Z

This PR adds the ability to return a thymeleaf fragment in a view instead of the whole template. Very useful for tools like htmx.org.

This code takes inspiration from the thymeleaf spring integration, found here

CLAassistant · 2023-12-19T21:42:07Z

All committers have signed the CLA.

sdelamo

I am interested in improving how to integrate better HTMX with Micronaut Views. And the same for Thymleaf. I use Thymleaf in my pet projects.

However, I am not sure I understand the benefit this PR adds. Currently, I can already render a thymleaf fragment in Micronaut Views template, I do something like:

                    <div th:replace="~{_piecharts :: piecharts(${charts.get(0)})}"></div>

and _piechart.html fragment is something like:

<th:block th:fragment="piechart(chart)" xmlns:th="http://www.thymeleaf.org">
    <div class="chart">
...
</th:block>

johannesg · 2023-12-20T19:28:36Z

@sdelamo You are correct in that you already can render a fragment within a template. What does not work however, is to render only a fragment. For example, these code examples do not currently work:

    public ModelAndView<?> editUser(@PathVariable("id") int id) {
        // ...
        return new ModelAndView<>("users :: editUser", model);
    }

    @Get("/users/{id}/edit")
    @View("users :: editUser")
    public UserModel editUser(@PathVariable("id") int id) {
        // ...
        return model;
    }

This PR adds support for this by parsing the view name and get its fragment selector before sending it to the renderer.

I'm also interested in improving integration with htmx. If this PR gets approved, I might give it a shot.

sdelamo · 2024-02-14T09:38:51Z

@sdelamo You are correct in that you already can render a fragment within a template. What does not work however, is to render only a fragment. For example, these code examples do not currently work:
    public ModelAndView<?> editUser(@PathVariable("id") int id) {
        // ...
        return new ModelAndView<>("users :: editUser", model);
    }
   @Get("/users/{id}/edit")
   @View("users :: editUser")
   public UserModel editUser(@PathVariable("id") int id) {
       // ...
       return model;
   }
This PR adds support for this by parsing the view name and get its fragment selector before sending it to the renderer.

I'm also interested in improving integration with htmx. If this PR gets approved, I might give it a shot.

Sorry for the delay. I set aside to work on this again. @johannesg this works:

https://github.com/sdelamo/button-click-change/blob/master/src/main/java/com/modernfrontendshtmx/HomeController.java#L17-L20

to answer a fragment:

https://github.com/sdelamo/button-click-change/blob/master/src/main/resources/views/htmx.html

The issue you are trying to address it to support the :: syntax. Why would you prefer to use htmx :: message instead of just htmx? to support files with multiple fragments on them?.

johannesg · 2024-02-14T09:46:39Z

@sdelamo Thank you for looking at this.

It's true, if you have one file per fragment, then your example works. However, if you organize multiple fragments in one file, like this:

<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Home</title>
</head>
<body>
  <div>MAIN</div>

  <div th:fragment="fragment1">FRAGMENT</div>

  <div th:fragment="fragment2">FRAGMENT</div>
</body>
</html>

And you only want to render "fragment1", then you would need the html :: fragment1 syntax. Just like th:replace does.

sdelamo · 2024-02-14T10:13:20Z

@johannesg can you sign the CLA again?. Sorry for the inconvenience.

johannesg · 2024-02-14T10:17:03Z

@johannesg can you sign the CLA again?. Sorry for the inconvenience.

Done

Add ability to render thymeleaf fragments

b54baf2

Make sure it finds the view with fragment selectors

47d4179

sdelamo reviewed Dec 20, 2023

View reviewed changes

sdelamo added 5 commits February 14, 2024 10:47

make spock tests more idiomatic

10e7bcf

extra WriteableUtils

a6c2248

remove unncessary public modifier

e50c741

use WriteableUtils

9785ca4

deprecate method

472482c

sdelamo approved these changes Feb 14, 2024

View reviewed changes

sdelamo added the type: enhancement New feature or request label Feb 14, 2024

sdelamo merged commit f0a5a4a into micronaut-projects:master Feb 14, 2024
20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ability to render thymeleaf fragments #678

Add ability to render thymeleaf fragments #678

johannesg commented Dec 19, 2023

CLAassistant commented Dec 19, 2023 •

edited

sdelamo left a comment •

edited

johannesg commented Dec 20, 2023

sdelamo commented Feb 14, 2024

johannesg commented Feb 14, 2024

sdelamo commented Feb 14, 2024 •

edited

johannesg commented Feb 14, 2024

Add ability to render thymeleaf fragments #678

Add ability to render thymeleaf fragments #678

Conversation

johannesg commented Dec 19, 2023

CLAassistant commented Dec 19, 2023 • edited

sdelamo left a comment • edited

Choose a reason for hiding this comment

johannesg commented Dec 20, 2023

sdelamo commented Feb 14, 2024

johannesg commented Feb 14, 2024

sdelamo commented Feb 14, 2024 • edited

johannesg commented Feb 14, 2024

CLAassistant commented Dec 19, 2023 •

edited

sdelamo left a comment •

edited

sdelamo commented Feb 14, 2024 •

edited