io.jooby.handlebars

Class HandlebarsModule

java.lang.Object

io.jooby.handlebars.HandlebarsModule

All Implemented Interfaces:

Extension

public class HandlebarsModule
extends Object
implements Extension

Handlebars module: https://jooby.io/modules/handlebars. Usage:

 {

   install(new HandlebarsModule());

   get("/", ctx -> {
     User user = ...;
     return new ModelAndView("index.hbs")
         .put("user", user);
   });
 }
 

The template engine looks for a file-system directory: views in the current user directory. If the directory doesn't exist, it looks for the same directory in the project classpath. You can specify a different template location:

 {

    install(new HandlebarsModule("mypath"));

 }
 

The mypath location works in the same way: file-system or fallback to classpath. Template engine supports the following file extensions: .ftl, .ftl.html and .html. Direct access to Handlebars is available via require call:

 {

   Handlebars hbs = require(Handlebars.class);

 }
 

Complete documentation is available at: https://jooby.io/modules/handlebars.

Since:

2.0.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HandlebarsModule.Builder Utility class for creating Handlebars instances.

Constructor Summary

Constructors

Constructor and Description
HandlebarsModule() Creates a new handlebars module using the default path: views.
HandlebarsModule(com.github.jknack.handlebars.Handlebars handlebars) Creates a new handlebars module.
HandlebarsModule(Path templatesPath) Creates a new handlebars module.
HandlebarsModule(String templatesPath) Creates a new handlebars module.

Method Summary

Modifier and Type	Method and Description
static HandlebarsModule.Builder	create() Creates a new freemarker builder.
void	install(Jooby application)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jooby.Extension

lateinit

Constructor Detail

HandlebarsModule

public HandlebarsModule(@Nonnull
                        com.github.jknack.handlebars.Handlebars handlebars)

Creates a new handlebars module.

Parameters:

handlebars - Handlebars instance to use.

HandlebarsModule

public HandlebarsModule(@Nonnull
                        String templatesPath)

Creates a new handlebars module.

Parameters:

templatesPath - Template location to use. First try to file-system or fallback to classpath.

HandlebarsModule

public HandlebarsModule(@Nonnull
                        Path templatesPath)

Creates a new handlebars module.

Parameters:

templatesPath - Template location to use. First try to file-system or fallback to classpath.

HandlebarsModule

public HandlebarsModule()

Creates a new handlebars module using the default path: views.

Method Detail

install

public void install(@Nonnull
                    Jooby application)
             throws Exception

Specified by:

install in interface Extension

Throws:

Exception

create

@Nonnull
public static HandlebarsModule.Builder create()

Creates a new freemarker builder.

Returns:

A builder.