ratpack.thymeleaf

Class ThymeleafModule

java.lang.Object

com.google.inject.AbstractModule

ratpack.thymeleaf.ThymeleafModule

All Implemented Interfaces:

Module

public class ThymeleafModule
extends AbstractModule

An extension module that provides support for Thymeleaf templating engine.

To use it one has to register the module and then render Template instances. Instances of Template can be created using one of the Template.thymeleafTemplate(java.util.Map, String, String) static methods.

By default templates are looked up in the thymeleaf directory of the application root with a .html suffix. So thymeleafTemplate("my/template/path") maps to thymeleaf/my/template/path.html in the application root directory. This can be configured using setTemplatesPrefix(String) and setTemplatesSuffix(String) as well as other.thymeleaf.templatesPrefix and other.thymeleaf.templatesSuffix configuration properties.

Response content type can be manually specified, i.e. thymeleafTemplate("template", model, "text/html") if not specified will default to text/html.

import ratpack.guice.Guice;
 import ratpack.test.embed.BaseDirBuilder;
 import ratpack.test.embed.EmbeddedApp;
 import ratpack.thymeleaf.ThymeleafModule;

 import java.nio.file.Path;

 import static ratpack.thymeleaf.Template.thymeleafTemplate;

 public class Example {

   public static void main(String... args) {
     Path baseDir = BaseDirBuilder.tmpDir().build(builder ->
         builder.file("thymeleaf/myTemplate.html", "<span th:text=\"${key}\"/>")
     );
     EmbeddedApp.fromHandlerFactory(baseDir, launchConfig ->
         Guice.builder(launchConfig)
           .bindings(b -> b.add(new ThymeleafModule()))
           .build(chain -> chain
               .get(ctx -> ctx.render(thymeleafTemplate("myTemplate", m -> m.put("key", "Hello Ratpack!"))))
           )
     ).test(httpClient -> {
       assert httpClient.getText().equals("<span>Hello Ratpack!</span>");
     });
   }
 }
 

To register dialects, use Guice Multibindings to bind an implementation of IDialect in a module.

See Also:

Thymeleaf, Guice Multibindings

Constructor Summary

Constructors

Constructor and Description
ThymeleafModule()

Method Summary

Modifier and Type	Method and Description
protected void	configure()
Integer	getTemplatesCacheSize()
String	getTemplatesMode()
String	getTemplatesPrefix()
String	getTemplatesSuffix()
void	setTemplatesCacheSize(Integer templatesCacheSize)
void	setTemplatesMode(String templatesMode)
void	setTemplatesPrefix(String templatesPrefix)
void	setTemplatesSuffix(String templatesSuffix)

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThymeleafModule

public ThymeleafModule()

Method Detail

getTemplatesMode

public String getTemplatesMode()

setTemplatesMode

public void setTemplatesMode(String templatesMode)

getTemplatesPrefix

public String getTemplatesPrefix()

setTemplatesPrefix

public void setTemplatesPrefix(String templatesPrefix)

getTemplatesSuffix

public String getTemplatesSuffix()

setTemplatesSuffix

public void setTemplatesSuffix(String templatesSuffix)

getTemplatesCacheSize

public Integer getTemplatesCacheSize()

setTemplatesCacheSize

public void setTemplatesCacheSize(Integer templatesCacheSize)

configure

protected void configure()

Specified by:

configure in class AbstractModule