bigpipe

Type Members

1. class BigPipe extends AnyRef

   

   This class composes the given Pagelets together and prepares them for either out-of-order client-side rendering (if renderOptions is set to ClientSide) or in-order server-side rendering (if renderOptions is set to ServerSide).

   This class composes the given Pagelets together and prepares them for either out-of-order client-side rendering (if renderOptions is set to ClientSide) or in-order server-side rendering (if renderOptions is set to ServerSide). Use the render method in this class in your templates to actually render the Pagelets. It provides you a Map from Pagelet id to the HtmlStream for that Pagelet. Insert the HtmlStream in this Map for each Pagelet into the appropriate part of your markup.

2. case class HtmlPagelet(id: String, content: Future[Html]) extends Pagelet with Product with Serializable

   

   A Pagelet that contains HTML.

   A Pagelet that contains HTML. Both server-side and client-side rendering are supported.

   id

   content

3. class HtmlStream extends Appendable[HtmlStream]

   

   A custom Appendable that lets you create .scala.stream templates instead of .scala.html.

   A custom Appendable that lets you create .scala.stream templates instead of .scala.html. These templates can mix Html markup with Enumerators that contain Html markup so that as soon as the content is available, Play can stream it back to the client. You need to add this class as a custom template type in build.sbt.

4. case class JsonPagelet(id: String, content: Future[JsValue]) extends Pagelet with Product with Serializable

   

   A Pagelet that contains JSON.

   A Pagelet that contains JSON. The general usage pattern is to send this JSON to the browser and render it using a client-side templating language, such as Mustache.js. Therefore, this Pagelet only supports client-side rendering and will throw an exception if you try to render it server-side.

   id

   content

5. trait Pagelet extends AnyRef

   

   The base trait for "pagelets", which represent small, self-contained pieces of a page that can be rendered independently.

6. case class TextPagelet(id: String, content: Future[String]) extends Pagelet with Product with Serializable

   

   A Pagelet that contains plain text.

   A Pagelet that contains plain text. Both server-side and client-side rendering are supported.

   id

   content