Packages

  • package root
    Definition Classes
    root
  • package router
    Definition Classes
    root
  • package browser
    Definition Classes
    router
  • trait ReactionRouterDOMComponent extends RoutingSourceComponent[PathParts, String] with RoutingConfig[PathParts, String]

    Routing using this facade's router context provider and targeted for the DOM and browser URLs.

    Routing using this facade's router context provider and targeted for the DOM and browser URLs. You don't need this class, you could just listen to the history changes using a browser's history API or the "history" js package. Use a instance of this component as an ancestor to provide the latest "history" location in a react context then use the Route component, a value dependent type, to perform routing anywhere in the application. The F context is Id so there is no effect wrapping a rule's Action.

    You may also want to look at the code behind the [history github](https://github.com/ReactTraining/history) package or [react-router-navigation-prompt](https://github.com/ZacharyRSmith/react-router-navigation-prompt) in order to see how to take an user confirmed action such as saving changes before routing away. If you roll your own, you will need to register an "beforeonload" handler with the window when the user types in a new URL and throw up a dialog. You can also register with the document's history object to indepdently listen to history changes and if the URLs are different, throw up a dialog.

    Definition Classes
    browser
  • Action
  • Config
  • ConfigLike
  • ControlLike
  • DOMControl
  • NavAction
  • NewInfo
  • Props
  • RedirectTo
  • Render
  • Route
  • RouterInfoLike
  • ShowIfMatch
  • Subscribe
  • rule

trait ConfigLike extends ReactionRouterDOMComponent.ConfigLike

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

Abstract Value Members

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

    Run after render loop, not immediately after render.

    Run after render loop, not immediately after render.

    Definition Classes
    ConfigLike
  2. abstract val prefixPath: Option[String]
  3. abstract val render: (Control, (Control) => ReactNode) => ReactNode

    Renders the content if the rules return a Render action.

    Renders the content if the rules return a Render action.

    Definition Classes
    ConfigLike
  4. abstract val rules: ReactionRouterDOMComponent.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).

    Definition Classes
    ConfigLike

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 ReactionRouterDOMComponent.ConfigLike

Inherited from AnyRef

Inherited from Any

Ungrouped