Type Members

1.  class ContextRouteBuilder[Bundle, Page, Ctx, CtxArgs] extends AnyRef

   A builder for routes with context.

   A builder for routes with context.

   Context, in this context (heheh), is a type that encodes a set of query params that is shared between the routes created by this builder.

   For example, your Laminar web app might have a big documentation section with many routes, but where every route is expected to have a "lang" query param to indicate the selected language and a "version" param to indicate the product version (unrealistic doc standards, I know).

   So, you could add these two params to every page type that needs them and to every route for those page types, but that could be annoying. So instead, you could create a ContextRouteBuilder which will let you specify the necessary types / conversions / patterns only once.

   See ContextRouteBuilderSpec for a concrete example.

   Bundle

   - The type of pages (including the context part) handled by the routes produced by this builder. A bundle consists of a route-specific Page, and a Context shared by all routes by this builder. In the simplest case, imagine case class Bundle(p: Page, ctx: Context)

   Page

   - The base type for the route-specific parts of the Bundle

   Ctx

   - The part of the Bundle shared by all routes made by this builder, In the simplest case, imagine case class SharedParams(lang: Option[String], version: Option[String])

2.  type FragmentPatternArgs[PathArgs, QueryArgs, FragmentArgs] = PathQueryFragmentMatching[PathArgs, QueryArgs, FragmentArgs]

   A bundle of path args, query param args, and fragment args

3.  type PatternArgs[PathArgs, QueryArgs] = UrlMatching[PathArgs, QueryArgs]

   A bundle of path args and query param args

4.  class Route[Page, Args] extends AnyRef

   Encoding and decoding are partial functions.

   Encoding and decoding are partial functions. Their partial-ness should be symmetrical, otherwise you'll end up with a route that can parse a URL into a Page but can't encode the page into the same URL (or vice versa)

   Page

   - Types of pages that this Route is capable of matching. Note: the Route might match only a subset of pages of this type.

   Args

   - Type of data saved in the URL for pages matched by this route Note: the Route might match only a subset of args of this type.

5.  class Waypoint[PathErr, QueryErr, FragErr] extends PathSegmentImpl[PathErr] with QueryParametersImpl[QueryErr] with FragmentImpl[FragErr]