Package

japgolly.scalajs.react.extra

router

Permalink

package router

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. router
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class AbsUrl(value: String) extends PathLike[AbsUrl] with Product with Serializable

    Permalink

    An absolute URL.

  2. sealed trait Action[P] extends Product with Serializable

    Permalink
  3. final case class BaseUrl(value: String) extends PathLike[BaseUrl] with Product with Serializable

    Permalink

    The prefix of all routes on a page.

    The prefix of all routes on a page.

    The router expects this to be a full URL. Examples: BaseUrl("http://www.blah.com/hello"), BaseUrl.fromWindowOrigin / "hello".

  4. final case class Path(value: String) extends PathLike[Path] with Product with Serializable

    Permalink

    The portion of the URL after the BaseUrl.

  5. abstract class PathLike[Self <: PathLike[Self]] extends AnyRef

    Permalink
  6. sealed trait Redirect[P] extends Action[P]

    Permalink
  7. final case class RedirectToPage[P](page: P, method: Method) extends Redirect[P] with Product with Serializable

    Permalink
  8. final case class RedirectToPath[P](path: Path, method: Method) extends Redirect[P] with Product with Serializable

    Permalink
  9. final case class Renderer[P](f: (RouterCtl[P]) ⇒ VdomElement) extends Action[P] with Product with Serializable

    Permalink
  10. final case class Resolution[P](page: P, render: () ⇒ VdomElement) extends Product with Serializable

    Permalink

    Result of the router resolving a URL and reaching a conclusion about what to render.

    Result of the router resolving a URL and reaching a conclusion about what to render.

    page

    Data representation (or command) of what will be drawn.

    render

    The render function provided by the rules and logic in RouterConfig.

  11. sealed abstract class RouteCmd[A] extends AnyRef

    Permalink
  12. type Router[P] = component.Js.ComponentWithRoot[Unit, Nullary, Unmounted[Unit, Resolution[P], Backend], Box[Unit], Nullary, JsUnmounted[Unit, Resolution[P], Backend]]

    Permalink
  13. case class RouterConfig[Page](parse: (Path) ⇒ Parsed[Page], path: (Page) ⇒ Path, action: (Path, Page) ⇒ Action[Page], renderFn: (RouterCtl[Page], Resolution[Page]) ⇒ VdomElement, postRenderFn: (Option[Page], Page) ⇒ Callback, logger: Logger) extends Product with Serializable

    Permalink
  14. final class RouterConfigDsl[Page] extends AnyRef

    Permalink

    DSL for creating RouterConfig.

    DSL for creating RouterConfig.

    Instead creating an instance of this yourself, use RouterConfigDsl.apply.

  15. abstract class RouterCtl[A] extends AnyRef

    Permalink

    Router controller.

    Router controller. A client API to the router.

    A

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

  16. final class RouterLogic[Page] extends Broadcaster[Unit]

    Permalink

    Performs all routing logic.

    Performs all routing logic.

    Page

    Routing rules context. Prevents different routing rule sets being mixed up.

  17. type RouterM[P] = MountedWithRoot[Id, Unit, Resolution[P], Backend, Unit, Resolution[P]]

    Permalink
  18. type RouterU[P] = UnmountedWithRoot[Unit, MountedImpure[Unit, Resolution[P], Backend], Box[Unit], JsMounted[Unit, Resolution[P], Backend]]

    Permalink

Value Members

  1. object AbsUrl extends Serializable

    Permalink
  2. object BaseUrl extends Serializable

    Permalink
  3. object Path extends Serializable

    Permalink
  4. object Redirect extends Serializable

    Permalink
  5. object RouteCmd

    Permalink
  6. object Router

    Permalink
  7. object RouterConfig extends Serializable

    Permalink
  8. object RouterConfigDsl

    Permalink
  9. object RouterCtl

    Permalink
  10. object StaticDsl

    Permalink

    This is not meant to be imported by library-users; RouterConfigDsl is the entire library-user-facing facade & DSL.

Inherited from AnyRef

Inherited from Any

Ungrouped