Skip to content
This repository has been archived by the owner on Oct 20, 2018. It is now read-only.

jsumners/thymeleaf-layout-interceptor

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 

Thymeleaf Layout Interceptor

This package provides an annotation and interceptor that add layouts support to Thymeleaf under Spring.

Install

Using Maven (or something compatible with Maven repositories):

<dependencies>
  <dependency>
    <groupId>com.jrfom</groupId>
    <artifactId>thymeleaf-layout-interceptor</artifactId>
    <version>0.1.0</version>
  </dependency>
</dependencies>

<repositories>
  <repository>
    <id>jsumners-github-releases</id>
    <url>https://github.com/jsumners/mvn-repo/raw/master/releases/</url>
  </repository>
  <repository>
    <id>jsumners-github-snapshots</id>
    <url>https://github.com/jsumners/mvn-repo/raw/master/snapshots/</url>
  </repository>
</repositories>

Usage

First, add the interceptor to your application:

public class ApplicationContextConfig extends WebMvcConfigurerAdapter {
  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    ThymeleafLayoutInterceptor layoutInterceptor = new ThymeleafLayoutInterceptor();
    layoutInterceptor.setDefaultLayout("layout"); // WEB-INF/templates/layout.html
    layoutInterceptor.setViewAttributeName("view"); // the default
    registry.addInterceptor(layoutInterceptor);

    super.addInterceptors(registry);
  }
}

Next, create a layout template:

<html>
<head></head>
<body>
  <header><h1>Example Layout</h1></header>

  <section id="viewContainer">
    <div th:replace="views/__${view}__ :: content" th:remove="tag"></div>
  </section>

  <footer><p>yay</p></footer>
</body>
</html>

And then a view in the "views" subdirectory of the "WEB-INF/templates":

<!-- foo.html -->
<html>
<body>
  <!-- Note the name of the fragment matches the one specified in the layout -->
  <div id="viewBody" th:fragment="content">
    <p>View body</p>
  </div>
</body>
</html>

Finally, implement a method that returns the layout and view name:

@Layout("layout")
@RequestMapping("/foo")
public String foo() {
  return "foo";
}

Or, you can ignore the annotation and rely on the defaults that are set on the interceptor:

@RequestMapping("/foo")
public ModelAndView foo() {
  ModelAndView mav = new ModelAndView();
  mav.setViewName("foo");

  // do some stuff

  return mav;
}

In either case, the rendered HTML would be:

<html>
<head></head>
<body>
  <header><h1>Example Layout</h1></header>

  <section id="viewContainer">
    <div id="viewBody">
      <p>View body</p>
    </div>
  </section>

  <footer><p>yay</p></footer>
</body>
</html>

About

A Spring interceptor to support layouts in Thymeleaf

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages