Documentation

You are viewing the documentation for the 2.0.7 release in the 2.0.x series of releases. The latest stable release series is 3.0.x.

§The template engine

§A type safe template engine based on Scala

Play 2.0 comes with a new and really powerful Scala-based template engine. This new template engine’s design was inspired by ASP.NET Razor. Specifically it is:

Templates are compiled, so you will see any errors right in your browser:

§Overview

A Play Scala template is a simple text file, that contains small blocks of Scala code. They can generate any text-based format, such as HTML, XML or CSV.

The template system has been designed to feel comfortable to those used to dealing with HTML, allowing web designers to easily work with the templates.

Templates are compiled as standard Scala functions, following a simple naming convention: If you create a views/Application/index.scala.html template file, it will generate a views.html.Application.index function.

For example, here is a simple template:

@(customer: Customer, orders: Seq[Order])
 
<h1>Welcome @customer.name!</h1>

<ul> 
@orders.map { order =>
  <li>@order.title</li>
} 
</ul>

You can then call this from any Scala code as you would call a function:

val html = views.html.Application.index(customer, orders)

§Syntax: the magic ‘@’ character

The Scala template uses @ as the single special character. Every time this character is encountered, it indicates the begining of a Scala statement. It does not require you to explicitly close the code-block - this will be inferred from your code:

Hello @customer.name!
       ^^^^^^^^^^^^^
        Scala code

Because the template engine automatically detects the end of your code block by analysing your code, this syntax only supports simple statements. If you want to insert a multi-token statement, explicitly mark it using brackets:

Hello @(customer.firstName + customer.lastName)!
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
                    Scala Code

You can also use curly brackets, as in plain Scala code, to write a multi-statements block:

Hello @{val name = customer.firstName + customer.lastName; name}!
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                             Scala Code

Because @ is a special character, you’ll sometimes need to escape it. Do this by using @@:

My email is bob@@example.com

§Template parameters

A template is simply a function, so it needs parameters, which must be declared on the first line of the template file:

@(customer: models.Customer, orders: Seq[models.Order])

You can also use default values for parameters:

@(title: String = "Home")

Or even several parameter groups:

@(title:String)(body: Html)

And even implicit parameters:

@(title: String)(body: Html)(implicit request: RequestHeader)

§Iterating

You can use the Scala for-comprehension, in a pretty standard way. But note that the template compiler will add a yield keyword before your block:

<ul>
@for(p <- products) {
  <li>@p.name ([email protected])</li>
} 
</ul>

As you probably know, this for-comprehension is just syntactic sugar for a classic map:

<ul>
@products.map { p =>
  <li>@p.name ([email protected])</li>
} 
</ul>

§If-blocks

If-blocks are nothing special. Simply use Scala’s standard if statement:

@if(items.isEmpty) {
  <h1>Nothing to display</h1>
} else {
  <h1>@items.size items!</h1>
}

§Pattern matching

You can also use pattern matching in your templates:

@connected match {
    
  case models.Admin(name) => {
    <span class="admin">Connected as admin (@name)</span>
  }

  case models.User(name) => {
    <span>Connected as @name</span>
  }
    
}

§Declaring reusable blocks

You can create reusable code blocks:

@display(product: models.Product) = {
  @product.name ([email protected])
}
 
<ul>
@products.map { p =>
  @display(product = p)
} 
</ul>

Note that you can also declare reusable pure Scala blocks:

@title(text: String) = @{
  text.split(' ').map(_.capitalize).mkString(" ")
}
 
<h1>@title("hello world")</h1>

Note: Declaring Scala block this way in a template can be sometimes useful but keep in mind that a template is not the best place to write complex logic. It is often better to externalize these kind of code in a pure scala source file (that you can store under the views/ package as well if you want).

By convention, a reusable block defined with a name starting with implicit will be marked as implicit:

@implicitFieldConstructor = @{ MyFieldConstructor() }

§Declaring reusable values

You can define scoped values using the defining helper:

@defining(user.firstName + " " + user.lastName) { fullName =>
  <div>Hello @fullName</div>
}

§Import statements

You can import whatever you want at the beginning of your template (or sub-template):

@(customer: models.Customer, orders: Seq[models.Order])
 
@import utils._
 
...

§Comments

You can write server side block comments in templates using @* *@:

@*********************
 * This is a comment *
 *********************@

You can put a comment on the first line to document your template into the Scala API doc:

@*************************************
 * Home page.                        *
 *                                   *
 * @param msg The message to display *
 *************************************@
@(msg: String)

<h1>@msg</h1>

§Escaping

By default, the dynamic content parts are escaped according the template type (e.g. HTML or XML) rules. If you want to output a raw content fragment, wrap it in the template content type.

For example to output raw HTML:

<p>
  @Html(article.content)    
</p>

Next: Common use cases