RoutingRules

Type Members

final type DynAction = (Path) ⇒ RouteAction[P]
final class DynB[T] extends AnyRef

Attributes
protected
case class DynamicRoute(route: DRouteFn) extends Product with Serializable

An unregistered dynamic route.
An unregistered dynamic route. Install via register().

Attributes
protected
case class InterceptionR(loc: Loc, router: Router, element: ReactElement) extends Product with Serializable

Attributes
protected
final type Loc = Location[P]
final type P = RoutingRules.this.type
final type RedirectTarget = \/[Path, Location[P]]
final type Renderer = (router.Router[P]) ⇒ ReactElement
final type Router = router.Router[P]
case class StaticRoute[A <: RouteAction[P]](path: Path, action: A) extends Product with Serializable

An unregistered static route.
An unregistered static route. Install via register().

Attributes
protected

Abstract Value Members

abstract val notFound: DynAction

The catch-all response to unmatched routes.
The catch-all response to unmatched routes.

Attributes
protected

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( ... )
implicit final def componentP_renderer[S, B, T <: TopNode](c: ReqProps[Router, S, B, T]): Renderer

Attributes
protected
Annotations
@inline()
implicit final def componentU_renderer[P, S, B, T <: TopNode](c: ConstProps[P, S, B, T]): Renderer

Attributes
protected
Annotations
@inline()
final def dynLink[T](path: (T) ⇒ String): (T) ⇒ DynamicLocation[P]

Generates paths for a dynamic route, which can then be passed to japgolly.scalajs.react.extra.router.Router to be turned into clickable links.
Generates paths for a dynamic route, which can then be passed to japgolly.scalajs.react.extra.router.Router to be turned into clickable links.
T
The value of the dynamic portion of the route. Example: PersonId(123).
path
Example: "person/123"

Attributes
protected
implicit final def element_renderer[A](a: A)(implicit arg0: (A) ⇒ ReactElement): Renderer

Attributes
protected
Annotations
@inline()
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
def interceptRender(i: InterceptionR): ReactElement

Customise all renderable routes.
Customise all renderable routes.

Attributes
protected
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit final def loc_redirectable(a: Loc): RedirectTarget

Attributes
protected
Annotations
@inline()
final def location(path: String, render: Renderer): StaticRoute[Loc]

Attributes
protected
final lazy val matchNumber: Regex

case matchNumber(num) => num.toLong
case matchNumber(num) => num.toLong

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onRouteChange(a: (Loc) ⇒ Unit): Unit

Perform an action when a new route is activated.
Perform an action when a new route is activated.

Attributes
protected
def onRouteChangeIO(a: (Loc) ⇒ IO[Unit]): Unit

Perform an action when a new route is activated.
Perform an action when a new route is activated.

Attributes
protected
final def parser[T](pf: PartialFunction[String, T]): DynB[T]

Parser for a dynamic path.
Parser for a dynamic path. Example: "person/123"
T
The value of the dynamic portion of the path. Example: "123" or PersonId(123).

Attributes
protected
implicit final def path_redirectable(p: Path): RedirectTarget

Attributes
protected
Annotations
@inline()
final def redirect(to: Loc, method: Method): DynAction

Attributes
protected
final def redirection(from: String, to: RedirectTarget, method: Method): StaticRoute[Redirect[P]]

Attributes
protected
final def register(u: DynamicRoute): Unit

Attributes
protected
final def register[A <: RouteAction[P]](u: StaticRoute[A]): A

Attributes
protected
final def removeTrailingSlashes: DynamicRoute

Registers a handle that uses a replace-state redirect to remove trailing slashes from unmatched route urls.
Registers a handle that uses a replace-state redirect to remove trailing slashes from unmatched route urls.

Attributes
protected
final def render(render: Renderer): DynAction

Attributes
protected
final def rootLocation(r: Renderer): StaticRoute[Loc]

Attributes
protected
final def router(base: BaseUrl, logger: Logger = nopLogger): Component[P]
final def routingEngine(base: BaseUrl, logger: Logger = nopLogger): Router
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( ... )

trait RoutingRules extends AnyRef

Type Members

final type DynAction = (Path) ⇒ RouteAction[P]

final class DynB[T] extends AnyRef

case class DynamicRoute(route: DRouteFn) extends Product with Serializable

case class InterceptionR(loc: Loc, router: Router, element: ReactElement) extends Product with Serializable

final type Loc = Location[P]

final type P = RoutingRules.this.type

final type RedirectTarget = \/[Path, Location[P]]

final type Renderer = (router.Router[P]) ⇒ ReactElement

final type Router = router.Router[P]

case class StaticRoute[A <: RouteAction[P]](path: Path, action: A) extends Product with Serializable

Abstract Value Members

abstract val notFound: DynAction

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit final def componentP_renderer[S, B, T <: TopNode](c: ReqProps[Router, S, B, T]): Renderer

implicit final def componentU_renderer[P, S, B, T <: TopNode](c: ConstProps[P, S, B, T]): Renderer

final def dynLink[T](path: (T) ⇒ String): (T) ⇒ DynamicLocation[P]

implicit final def element_renderer[A](a: A)(implicit arg0: (A) ⇒ ReactElement): Renderer

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def interceptRender(i: InterceptionR): ReactElement

final def isInstanceOf[T0]: Boolean

implicit final def loc_redirectable(a: Loc): RedirectTarget

final def location(path: String, render: Renderer): StaticRoute[Loc]

final lazy val matchNumber: Regex

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onRouteChange(a: (Loc) ⇒ Unit): Unit

def onRouteChangeIO(a: (Loc) ⇒ IO[Unit]): Unit

final def parser[T](pf: PartialFunction[String, T]): DynB[T]

implicit final def path_redirectable(p: Path): RedirectTarget

final def redirect(to: Loc, method: Method): DynAction

final def redirection(from: String, to: RedirectTarget, method: Method): StaticRoute[Redirect[P]]

final def register(u: DynamicRoute): Unit

final def register[A <: RouteAction[P]](u: StaticRoute[A]): A

final def removeTrailingSlashes: DynamicRoute

final def render(render: Renderer): DynAction

final def rootLocation(r: Renderer): StaticRoute[Loc]

final def router(base: BaseUrl, logger: Logger = nopLogger): Component[P]

final def routingEngine(base: BaseUrl, logger: Logger = nopLogger): Router

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