extra
API
Generated with
extra/japgolly.scalajs.react.extra/japgolly.scalajs.react.extra.router/RouterCtlF

RouterCtlF

japgolly.scalajs.react.extra.router.RouterCtlF
See theRouterCtlF companion object
abstract class RouterCtlF[F[_], Route]

Router controller. A client API to the router.

Type parameters

Route

A data type that indicates a route that can be navigated to.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AltEffect[F, G, A]
class Contramap[F, A, B]
class ModCB[F, A]

Members list

Value members

Abstract methods

def pathFor(route: Route): Path
def refresh: F[Unit]
def set(route: Route, via: SetRouteVia): F[Unit]

Concrete methods

final def contramap[B](f: B => Route): RouterCtlF[F, B]
final def narrow[B <: Route]: RouterCtlF[F, B]
final def onLinkClick(route: Route): ReactMouseEvent => Option[F[Unit]]
final def onSet(f: (Route, F[Unit]) => F[Unit]): RouterCtlF[F, Route]

Change the behaviour of set and all derivatives.

Change the behaviour of set and all derivatives.

For example, this can be used to set a component's state immediately before setting a new route.

Attributes

final def onSet(f: F[Unit] => F[Unit]): RouterCtlF[F, Route]

Change the behaviour of set and all derivatives.

Change the behaviour of set and all derivatives.

For example, this can be used to set a component's state immediately before setting a new route.

Attributes

final def onSetRun(f: F[Unit]): RouterCtlF[F, Route]

Return a new version of this that executes the specified callback after setting new routes.

Return a new version of this that executes the specified callback after setting new routes.

Attributes

final def set(route: Route): F[Unit]
final def setEH(route: Route): ReactEvent => F[Unit]
final def setOnClick(route: Route): TagMod
final def setOnLinkClick(route: Route): TagMod
final def urlFor(route: Route): AbsUrl
def withEffect[G[_]](implicit G: Sync[G]): RouterCtlF[G, Route]

Deprecated methods

final def setOnClick(route: Route, callback: F[Unit]): TagMod

Attributes

Deprecated
true
final def setOnLinkClick(route: Route, callback: F[Unit]): TagMod

Attributes

Deprecated
true
Generated with