abstract class RouterCtlF[F[_], Route] extends AnyRef

Router controller. A client API to the router.

Route

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

Linear Supertypes
AnyRef, Any
Known Subclasses
AltEffect, Contramap, ModCB
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RouterCtlF
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RouterCtlF()

Abstract Value Members

  1. implicit abstract def F: Sync[F]
    Attributes
    protected
  2. abstract def baseUrl: BaseUrl
  3. abstract def byPath: RouterCtlF[F, Path]
  4. abstract def pathFor(route: Route): Path
  5. abstract def refresh: F[Unit]
  6. abstract def set(route: Route, via: SetRouteVia): F[Unit]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def contramap[B](f: (B) => Route): RouterCtlF[F, B]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def link(route: Route): vdom.html_<^.VdomTagOf[Anchor]
  13. final def narrow[B <: Route]: RouterCtlF[F, B]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def onLinkClick(route: Route): (internal.CoreGeneral.ReactMouseEvent) => Option[F[Unit]]
  18. 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.

  19. 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.

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

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

  21. final def set(route: Route): F[Unit]
  22. final def setEH(route: Route): (internal.CoreGeneral.ReactEvent) => F[Unit]
  23. final def setOnClick(route: Route): vdom.html_<^.TagMod
  24. final def setOnLinkClick(route: Route): vdom.html_<^.TagMod
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def urlFor(route: Route): AbsUrl
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. def withEffect[G[_]](implicit G: Sync[G]): RouterCtlF[G, Route]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. final def link(route: Route, callback: F[Unit]): vdom.html_<^.VdomTagOf[Anchor]
    Annotations
    @deprecated
    Deprecated

    (Since version forever) Use .onSetRun(callback).link(route)

  3. final def setOnClick(route: Route, callback: F[Unit]): vdom.html_<^.TagMod
    Annotations
    @deprecated
    Deprecated

    (Since version forever) Use .onSetRun(callback).setOnClick(route)

  4. final def setOnLinkClick(route: Route, callback: F[Unit]): vdom.html_<^.TagMod
    Annotations
    @deprecated
    Deprecated

    (Since version forever) Use .onSetRun(callback).setOnLinkClick(route)

Inherited from AnyRef

Inherited from Any

Ungrouped