javascriptRouter

Generates a Javascript object that lets you refer to your application's routes in Javascript code

Example:

@javascriptRouter("jsRoutes")(
  routes.javascript.Users.list,
  routes.javascript.Application.index
)

You can access your routes in JavaScript without hardcoded URL's, e.g. assuming jQuery's ajax function:

$.ajax(jsRoutes.controllers.Users.list()).done( /* */ ).fail( /* */ )

Each action in the generated object also has the following properties: * *type*: HTTP method * *url*: the url to be used

Source: javascriptRouter.template.scala

Linear Supertypes

javascriptRouter_Scope0.javascriptRouter, Template3[String, Array[JavaScriptReverseRoute], RequestHeader, play.twirl.api.HtmlFormat.Appendable], BaseScalaTemplate[play.twirl.api.HtmlFormat.Appendable, Format[play.twirl.api.HtmlFormat.Appendable]], Serializable, Serializable, Product, Equals, AnyRef, Any

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
def _display_(o: Any)(implicit m: Manifest[play.twirl.api.HtmlFormat.Appendable]): play.twirl.api.HtmlFormat.Appendable

Definition Classes
BaseScalaTemplate
def _display_(x: play.twirl.api.HtmlFormat.Appendable): play.twirl.api.HtmlFormat.Appendable

Definition Classes
BaseScalaTemplate
def _display_(x: NodeSeq): play.twirl.api.HtmlFormat.Appendable

Definition Classes
BaseScalaTemplate
def _display_(x: Unit): play.twirl.api.HtmlFormat.Appendable

Definition Classes
BaseScalaTemplate
def _display_(x: String): play.twirl.api.HtmlFormat.Appendable

Definition Classes
BaseScalaTemplate
def _display_(x: AnyVal): play.twirl.api.HtmlFormat.Appendable

Definition Classes
BaseScalaTemplate
def apply(name: String = "Router")(routes: JavaScriptReverseRoute*)(implicit request: RequestHeader): play.twirl.api.HtmlFormat.Appendable

Generates a Javascript object that lets you refer to your application's routes in Javascript code
Generates a Javascript object that lets you refer to your application's routes in Javascript code
Example:
```
@javascriptRouter("jsRoutes")(
  routes.javascript.Users.list,
  routes.javascript.Application.index
)
```
You can access your routes in JavaScript without hardcoded URL's, e.g. assuming jQuery's ajax function:
```
$.ajax(jsRoutes.controllers.Users.list()).done( /* */ ).fail( /* */ )
```
Each action in the generated object also has the following properties: * *type*: HTTP method * *url*: the url to be used
name
The javascript object name.
routes
Set of routes to include in this javascript router.

Definition Classes
javascriptRouter
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 f: (String) ⇒ (Array[JavaScriptReverseRoute]) ⇒ (RequestHeader) ⇒ play.twirl.api.HtmlFormat.Appendable

Definition Classes
javascriptRouter
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val format: Format[play.twirl.api.HtmlFormat.Appendable]

Definition Classes
BaseScalaTemplate
final def getClass(): Class[_]

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
def ref: javascriptRouter.this.type

Definition Classes
javascriptRouter
def render(name: String, routes: Array[JavaScriptReverseRoute], request: RequestHeader): play.twirl.api.HtmlFormat.Appendable

Definition Classes
javascriptRouter → Template3
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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 Doc: package helper

object javascriptRouter extends helper.javascriptRouter_Scope0.javascriptRouter

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def _display_(o: Any)(implicit m: Manifest[play.twirl.api.HtmlFormat.Appendable]): play.twirl.api.HtmlFormat.Appendable

def _display_(x: play.twirl.api.HtmlFormat.Appendable): play.twirl.api.HtmlFormat.Appendable

def _display_(x: NodeSeq): play.twirl.api.HtmlFormat.Appendable

def _display_(x: Unit): play.twirl.api.HtmlFormat.Appendable

def _display_(x: String): play.twirl.api.HtmlFormat.Appendable

def _display_(x: AnyVal): play.twirl.api.HtmlFormat.Appendable

def apply(name: String = "Router")(routes: JavaScriptReverseRoute*)(implicit request: RequestHeader): play.twirl.api.HtmlFormat.Appendable

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def f: (String) ⇒ (Array[JavaScriptReverseRoute]) ⇒ (RequestHeader) ⇒ play.twirl.api.HtmlFormat.Appendable

def finalize(): Unit

val format: Format[play.twirl.api.HtmlFormat.Appendable]

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def ref: javascriptRouter.this.type

def render(name: String, routes: Array[JavaScriptReverseRoute], request: RequestHeader): play.twirl.api.HtmlFormat.Appendable

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from javascriptRouter_Scope0.javascriptRouter

Inherited from Template3[String, Array[JavaScriptReverseRoute], RequestHeader, play.twirl.api.HtmlFormat.Appendable]

Inherited from BaseScalaTemplate[play.twirl.api.HtmlFormat.Appendable, Format[play.twirl.api.HtmlFormat.Appendable]]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped