Packages

  • package root
    Definition Classes
    root
  • package router
    Definition Classes
    root
  • package browser
    Definition Classes
    router
  • trait RoutingConfig[Info <: AnyRef, To] extends AnyRef

    A collection of routing config types so you can compose routing rules.

    A collection of routing config types so you can compose routing rules. The rules do not prescribe a specific "Info" to "Action" matching model so you are free to choose your own. You can use sparse.tech [trail](https://github.com/sparsetech) or something like [path-to-regexp](https://github.com/pillarjs/path-to-regexp). Also, look at [You might not need React Router](https://medium.freecodecamp.org/you-might-not-need-react-router-38673620f3d) for ideas. That article uses an array of regexp to async functions vs a total function descibed in Rules below. Since the returned action is warpped in a F, any router using this trait will need to know how to run F.

    Info

    The request info pushed from the routing source.

    To

    A value representing where to go to.

    Definition Classes
    browser
  • Action
  • Config
  • ConfigLike
  • Control
  • ControlLike
  • RedirectTo
  • Render
  • rule

trait ConfigLike extends AnyRef

Config holds the routing rules, an absolute function. There is no deferral to a parent router but you can nest Router components with different configs. The RouterComponent is not dependent on a specific history management approach so it provides hooks to tie into the history mechanism of your choice using RoutingSource.

Linear Supertypes
AnyRef, Any
Known Subclasses
ReactionConfig, ConfigLike
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfigLike
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val postRender: Option[(Info) => Unit]

    Run after render loop, not immediately after render.

  2. abstract val render: (Control, (Control) => ReactNode) => ReactNode

    Renders the content if the rules return a Render action.

  3. abstract val rules: Rules

    Route rules.

    Route rules. You may want to use a router matcher library e.g. sparsetech.trail or pattern match on the path parts. Return an Action that renders to null to remove the router from react rendering. This is a total function so you are responsible for returning an Action even if its for an unplanned page (e.g. 404).

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]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped