App.Shared

Cross-cutting shared state management.

The shared state is global state accessible to all pages. Pages read it through their function signatures (it's passed to init, view, subscriptions) and update it through Effects.

Users define their own shared type and provide init/update/subscriptions:

type alias Shared =
    { user : Maybe User
    , theme : Theme
    , apiUrl : String
    }


sharedConfig : SharedConfig Flags Shared SharedMsg
sharedConfig =
    App.Shared.sharedConfig
        { init = \flags -> ( { user = Nothing, theme = Light, apiUrl = flags.apiUrl }, Cmd.none )
        , update = \msg shared -> ( shared, Cmd.none )
        , subscriptions = \shared -> Sub.none
        }

Types

type SharedConfig flags shared sharedMsg

Configuration for shared state management. Opaque type that bundles init, update, and subscriptions for the shared state.

Configuration

sharedConfig :

{ init : flags -> ( shared, Cmd sharedMsg )

, update : sharedMsg -> shared -> ( shared, Cmd sharedMsg )

, subscriptions : shared -> Sub sharedMsg

}

-> SharedConfig flags shared sharedMsg

Create a shared state configuration.

Runtime

initShared :

SharedConfig flags shared sharedMsg

-> flags

-> ( shared, Cmd sharedMsg )

Initialize the shared state from flags.

updateShared :

SharedConfig flags shared sharedMsg

-> sharedMsg

-> shared

-> ( shared, Cmd sharedMsg )

Update the shared state with a message.

sharedSubscriptions : SharedConfig flags shared sharedMsg -> shared -> Sub sharedMsg

Get shared state subscriptions.

joshburgess/elm-route-craft/1.0.0

App.Shared

Types

Configuration

Runtime

Modules