Helper

The Scandlebars definition of a handlebars helper.

The recommended fashion in which to define a helper is as follows. HelperOptions.lookup returns an Option which will evaluate to an empty string if the lookup does not yield a result.

val fullNameHelper = Helper {
  (binding, options) =>
    "%s %s".format(options.lookup("firstName"), options.lookup("lastName"))
}

It may be likely that you can predict the type of binding in practice. You could attempt to cast the context binding to the type you expect. This runs the risk of throwing a ClassCastException while rendering the template, which may be desirable. Use cautiously.

val fullNameHelper = Helper {
  (binding, options) =>
    val person = binding.asInstanceOf[Person]
    "%s %s".format(person.firstName, person.lastName)
}

See com.gilt.handlebars.scala.helper.HelperOptions for all of the options available.

Linear Supertypes

AnyRef, Any

Known Subclasses

EachHelper, IfHelper, LogHelper, StaticHelper, WithHelper

Abstract Value Members

abstract def apply(binding: Binding[T], options: HelperOptions[T])(implicit contextFactory: BindingFactory[T]): String

Executes the helper
Executes the helper
binding
the context object for the helper
options
the options or utility methods for the helper.
returns
String result after evaluating the helper

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Helper | package helper

trait Helper[T] extends AnyRef

Abstract Value Members

abstract def apply(binding: Binding[T], options: HelperOptions[T])(implicit contextFactory: BindingFactory[T]): String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped