danhandrea/elm-router/1.1.0

NOTE: the latest version is 4.3.0

Router

Router

Manages elm routing pages

Router, Config, Msg

type Router route

Router

type alias Config msg route routeMsg =
{ parser : Parser (route -> route) route
, update : routeMsg -> ( route, Cmd routeMsg )
, view : route -> List (Html routeMsg)
, message : Msg routeMsg -> msg
, subscriptions : route -> Sub routeMsg
, notFound : Url -> List (Html msg)
, routeTitle : route -> Maybe String
}

Config

type Msg routeMsg

Msg

Application

onUrlChange : Config msg route routeMsg -> Url -> msg

onUrlChange

onUrlRequest : Config msg route routeMsg -> UrlRequest -> msg

onUrlRequest

title : Router route -> String -> String

title

init

init : Config msg route routeMsg -> Url -> Key -> Router route

Init

update

Config msg route routeMsg
-> Msg routeMsg
-> Router route
-> ( Router route, Cmd msg )

update

view

view : Config msg route routeMsg -> Router route -> List (Html msg)

view

subscriptions

subscriptions : Config msg route routeMsg -> Router route -> Sub msg

subscriptions

mapping

mapMsg : (routeMsg -> msgType) -> List (Html routeMsg) -> List (Html msgType)

mapMsg

mapRoute : Parser a routeType -> a -> Parser (routeType -> b) b

mapRoute

(routeModel -> routeType)
-> (routeModel -> routeMsg -> msgType)
-> ( routeModel, Cmd routeMsg )
-> ( routeType, Cmd msgType )

mapUpdate

Query

currentUrl : Router route -> Url

currentUrl

currentRoute : Router route -> Maybe route

currentRoute

currentViewPort : Router route -> Maybe Viewport

currentViewPort