org.jooby.hbs

Class Hbs

java.lang.Object

org.jooby.hbs.Hbs

All Implemented Interfaces:

Jooby.Module

public class Hbs
extends Object
implements Jooby.Module

handlebars

Logic-less and semantic Mustache templates via handlebars.java.

exports

• Handlebars object.
• Renderer object.

usage

It is pretty straightforward:

 {
   use(new Hbs());

   get("/", req  -> Results.html("index").put("model", new MyModel());
 }
 

public/index.html:

   {{model}}
 

Templates are loaded from root of classpath: / and must end with: .html file extension.

options

helpers

Simple/basic helpers are add it at startup time:

 {
   use(new Hbs().doWith((hbs, config)  -> {
     hbs.registerHelper("myhelper", (ctx, options)  -> {
       return ...;
     });
     hbs.registerHelpers(Helpers.class);
   });
 }
 

Now, if the helper depends on a service and require injection:

 {
   use(new Hbs().with(Helpers.class));
 }
 

The Helpers will be injected by Guice and Handlebars will scan and discover any helper method.

template loader

Templates are loaded from the root of classpath and must end with .html. You can change the default template location and extensions too:

 {
   use(new Hbs("/", ".hbs"));
 }
 

cache

Cache is OFF when env=dev (useful for template reloading), otherwise is ON.

Cache is backed by Guava and the default cache will expire after 100 entries.

If 100 entries is not enough or you need a more advanced cache setting, just set the hbs.cache option:

 hbs.cache = "expireAfterWrite=1h"
 

See CacheBuilderSpec.

That's all folks! Enjoy it!!!

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Hbs(Class<?>... helpers) Creates a new Hbs module.
Hbs(String prefix, Class<?>... helpers) Creates a new Hbs module.
Hbs(String prefix, String suffix, Class<?>... helpers) Creates a new Hbs module.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Hbs	doWith(BiConsumer<com.github.jknack.handlebars.Handlebars,com.typesafe.config.Config> callback) Set a handlebars callback.
Hbs	doWith(Consumer<com.github.jknack.handlebars.Handlebars> callback) Set a handlebars callback.
Hbs	with(Class<?>... helper) Append one or more helper classes.
Hbs	with(com.github.jknack.handlebars.ValueResolver resolver) Append a ValueResolver.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hbs

public Hbs(String prefix,
           String suffix,
           Class<?>... helpers)

Creates a new Hbs module.

Parameters:

prefix - Template prefix.

suffix - Template suffix.

helpers - Optional list of helpers.

Hbs

public Hbs(String prefix,
           Class<?>... helpers)

Creates a new Hbs module.

Parameters:

prefix - Template prefix.

helpers - Optional list of helpers.

Hbs

public Hbs(Class<?>... helpers)

Creates a new Hbs module.

Parameters:

helpers - Optional list of helpers.

Method Detail

doWith

public Hbs doWith(BiConsumer<com.github.jknack.handlebars.Handlebars,com.typesafe.config.Config> callback)

Set a handlebars callback. Usage:

 {
   use(new Hbs().doWith((hbs, conf) -> {
     ...
   });
 }
 

Parameters:

callback - Configurer callback.

Returns:

This module.

doWith

public Hbs doWith(Consumer<com.github.jknack.handlebars.Handlebars> callback)

Set a handlebars callback.

 {
   use(new Hbs().doWith((hbs, conf) -> {
     ...
   });
 }
 

Parameters:

callback - Configurer callback.

Returns:

This module.

with

public Hbs with(Class<?>... helper)

Append one or more helper classes.

Parameters:

helper - Helper class.

Returns:

This module.

with

public Hbs with(com.github.jknack.handlebars.ValueResolver resolver)

Append a ValueResolver.

Parameters:

resolver - Resolver.

Returns:

This module.

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module