Routing

tyrian.Routing
object Routing

Provides a number of convenience functions to help with routing in simple use-cases. Here the Location type is typically hidden away and the user is expected to match on the String href (if at all).

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Routing.type

Members list

Value members

Concrete methods

def all[Msg](forward: String => Msg): Location => Msg

Provides a frontend router that treats all links the same way and simply forwards the href to the update function to be dealt with there. Does not differentiate between internal and external links.

Provides a frontend router that treats all links the same way and simply forwards the href to the update function to be dealt with there. Does not differentiate between internal and external links.

Value parameters

externalHRef

A function that converts an external href (url) to a Msg, i.e. a link to a different website.

internalHRef

A function that converts an internal href (url) to a Msg, i.e. a link to another page on this website.

Attributes

def basic[Msg](internalHRef: String => Msg, externalHRef: String => Msg): Location => Msg

Provides ultra simple frontend router based on string matching for convience in minimal use cases.

Provides ultra simple frontend router based on string matching for convience in minimal use cases.

Value parameters

externalHRef

A function that converts an external href (url) to a Msg, i.e. a link to a different website.

internalHRef

A function that converts an internal href (url) to a Msg, i.e. a link to another page on this website.

Attributes

def externalOnly[Msg](ignore: Msg, externalHRef: String => Msg): Location => Msg

Provides a simple frontend router that ignores internal links to the app's own website (i.e. your app really is a single page app), but allows you to follow external links to other sites.

Provides a simple frontend router that ignores internal links to the app's own website (i.e. your app really is a single page app), but allows you to follow external links to other sites.

Value parameters

externalHRef

A function that converts an external href (url) to a Msg, i.e. a link to a different website.

ignore

A user defined 'no-op' Msg that means "ignore this link/href".

Attributes

def none[Msg](ignore: Msg): Location => Msg

Provides a frontend router that ignores and deactivates all links fired by the app. In other words, no <a href> style links will work. Does not differentiate between internal and external links.

Provides a frontend router that ignores and deactivates all links fired by the app. In other words, no <a href> style links will work. Does not differentiate between internal and external links.

Value parameters

ignore

A user defined 'no-op' Msg that means "ignore this link/href".

Attributes