c

japgolly.scalajs.react.extra.router

RouterWithPropsConfig

case class RouterWithPropsConfig[Page, Props](rules: RoutingRules[Page], renderFn: (RouterCtl[Page], ResolutionWithProps[Page, Props]) => (Props) => VdomElement, postRenderFn: (Option[Page], Page, Props) => Callback, logger: Logger) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RouterWithPropsConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RouterWithPropsConfig(rules: RoutingRules[Page], renderFn: (RouterCtl[Page], ResolutionWithProps[Page, Props]) => (Props) => VdomElement, postRenderFn: (Option[Page], Page, Props) => Callback, logger: Logger)

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. def detectErrors(pages: Page*): CallbackTo[Vector[String]]

    Check specified pages for possible route config errors, and returns any detected.

    Check specified pages for possible route config errors, and returns any detected.

    Note: Requires that Page#equals() be sensible. Note: If elidable.ASSERTION is elided, this always returns an empty collection.

    returns

    Error messages (or an empty collection if no errors are detected).

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. def logToConsole: RouterWithPropsConfig[Page, Props]
  11. def logWith(l: Logger): RouterWithPropsConfig[Page, Props]
  12. val logger: Logger
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def onPostRender(f: (Option[Page], Page) => Callback): RouterWithPropsConfig[Page, Props]

    Add an procedure to be performed after the router renders.

    Add an procedure to be performed after the router renders.

    f

    Given the previous page and the current page that just rendered, return a callback.

  17. def onPostRenderP(f: (Option[Page], Page, Props) => Callback): RouterWithPropsConfig[Page, Props]

    Add an procedure to be performed after the router renders.

    Add an procedure to be performed after the router renders.

    f

    Given the previous page, the current page that just rendered and props, return a callback.

  18. val postRenderFn: (Option[Page], Page, Props) => Callback
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val renderFn: (RouterCtl[Page], ResolutionWithProps[Page, Props]) => (Props) => VdomElement
  21. def renderWith(f: (RouterCtl[Page], ResolutionWithProps[Page, Props]) => VdomElement): RouterWithPropsConfig[Page, Props]

    Specify how to render a page once it's resolved.

    Specify how to render a page once it's resolved. This function will be applied to all renderable pages.

  22. def renderWithP(f: (RouterCtl[Page], ResolutionWithProps[Page, Props]) => (Props) => VdomElement): RouterWithPropsConfig[Page, Props]

    Specify how to render a page once it's resolved.

    Specify how to render a page once it's resolved. This function will be applied to all renderable pages.

  23. val rules: RoutingRules[Page]
  24. def setPostRender(f: (Option[Page], Page) => Callback): RouterWithPropsConfig[Page, Props]

    Specify (entirely) what to do after the router renders.

    Specify (entirely) what to do after the router renders.

    f

    Given the previous page and the current page that just rendered, return a callback.

  25. def setPostRenderP(f: (Option[Page], Page, Props) => Callback): RouterWithPropsConfig[Page, Props]

    Specify (entirely) what to do after the router renders.

    Specify (entirely) what to do after the router renders.

    f

    Given the previous page, the current page that just rendered and props, return a callback.

  26. def setTitle(f: (Page) => String): RouterWithPropsConfig[Page, Props]

    Change the document title after the router renders.

    Change the document title after the router renders.

    f

    Given the current page that just rendered, return a new title.

  27. def setTitleOption(f: (Page) => Option[String]): RouterWithPropsConfig[Page, Props]

    Change the document title after the router renders.

    Change the document title after the router renders.

    f

    Given the current page that just rendered, return potential new title.

  28. def setTitleOptionP(f: (Page, Props) => Option[String]): RouterWithPropsConfig[Page, Props]

    Change the document title after the router renders.

    Change the document title after the router renders.

    f

    Given the current page that just rendered and props, return potential new title.

  29. def setTitleP(f: (Page, Props) => String): RouterWithPropsConfig[Page, Props]

    Change the document title after the router renders.

    Change the document title after the router renders.

    f

    Given the current page that just rendered and props, return a new title.

  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def verify(page1: Page, pages: Page*): RouterWithPropsConfig[Page, Props]

    Asserts that the page arguments provided, don't encounter any route config errors.

    Asserts that the page arguments provided, don't encounter any route config errors.

    If any errors are detected, the Router will be replaced with a new dummy router that displays the error messages.

    If you want direct, programmatic access to the errors themselves, use detectErrors() instead.

    Note: Requires that Page#equals() be sensible. Note: If elidable.ASSERTION is elided, this always returns this.

    returns

    In the event that errors are detected, a new RouterConfig that displays them; else this unmodified.

  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped