org.jooby.jade

Class Jade

java.lang.Object

org.jooby.jade.Jade

All Implemented Interfaces:

Jooby.Module

public class Jade
extends Object
implements Jooby.Module

jade

jade4j's intention is to be able to process jade templates in Java without the need of a JavaScript environment, while being fully compatible with the original jade syntax.

usage

 {
   use(new Jade());

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

   // or via API
   get("/jade-api", req  -> {
     JadeConfiguration jade = req.require(JadeConfiguration.class);
     JadeTemplate template = jade.getTemplate("index");
     template.renderTemplate(...);
   });
 }
 

Templates are loaded from root of classpath: / and must ends with: .jade file extension.

req locals

A template engine has access to ```request locals``` (a.k.a attributes). Here is an example:

 {
   use(new Jade());

   get("*", req  -> {
     req.set("req", req);
     req.set("session", req.session());
   });
 }
 

By default, there is no access to ```req``` or ```session``` from your template. This example shows how to do it.

template loader

Templates are loaded from the root of classpath and must ends with .jade. You can change the extensions too:

 {
   use(new Jade(".html"));
 }
 

Keep in mind if you change it file name must ends with: .html.jade.

template cache

Cache is OFF when application.env = dev (useful for template reloading), otherwise is ON and does not expire, unless you explicitly set jade.caching.

pretty print

Pretty print is on when application.env = dev , otherwise is off, unless unless you explicitly set jade.prettyprint.

That's all folks! Enjoy it!!!

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
Jade() Creates a Jade instance with default suffix .jade.
Jade(String suffix) Creates a Jade instance with a custom suffix.

Method Summary

Modifier and Type	Method and Description
void	configure(Env env, com.typesafe.config.Config conf, com.google.inject.Binder binder)
Jade	doWith(BiConsumer<de.neuland.jade4j.JadeConfiguration,com.typesafe.config.Config> callback) Configure callback that let you tweak or modified a JadeConfiguration.
Jade	doWith(Consumer<de.neuland.jade4j.JadeConfiguration> callback) Configure callback that let you tweak or modified a JadeConfiguration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Jooby.Module

config

Constructor Detail

Jade

public Jade(String suffix)

Creates a Jade instance with a custom suffix.

Parameters:

suffix - A suffix like .html. But keep in mind the final extension will be .html.jade

Jade

public Jade()

Creates a Jade instance with default suffix .jade.

Method Detail

doWith

public Jade doWith(Consumer<de.neuland.jade4j.JadeConfiguration> callback)

Configure callback that let you tweak or modified a JadeConfiguration.

Parameters:

callback - A callback.

Returns:

This module.

doWith

public Jade doWith(BiConsumer<de.neuland.jade4j.JadeConfiguration,com.typesafe.config.Config> callback)

Configure callback that let you tweak or modified a JadeConfiguration.

Parameters:

callback - A callback.

Returns:

This module.

configure

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

Specified by:

configure in interface Jooby.Module