single page apps made easy
Go to file
2020-03-29 20:50:31 -05:00
cli fix links to elm package docs 2020-03-28 14:55:08 -05:00
examples create more examples 2020-03-29 20:50:31 -05:00
src version 4 bb 2020-03-26 23:43:08 -05:00
.gitignore use correct routing order 2020-03-28 01:16:04 -05:00
.travis.yml Update .travis.yml 2020-03-28 01:44:02 -05:00
docs.json version 4 bb 2020-03-26 23:43:08 -05:00
elm.json version 4 bb 2020-03-26 23:43:08 -05:00
LICENSE add license 2020-03-26 23:47:53 -05:00
README.md oops tabs are hard 🤷‍♂️ 2020-03-28 15:00:02 -05:00

elm-spa

Build Status

single page apps made easy

When you create an app with the elm/browser package, you can build anything from a static Html msg page to a fully-fledged web Browser.application.

elm-spa uses that design at the page-level, so you can quickly add new pages to your Elm application!

Make your page as simple as you need:

module Pages.Home exposing (page)

-- can render a static page
page : Page Flags Model Msg
page =
    Page.static
        { view = view
        }
module Pages.About exposing (page)

-- can keep track of page state
page : Page Flags Model Msg
page =
    Page.sandbox
        { init = init
        , update = update
        , view = view
        }
module Pages.Posts exposing (page)

-- can perform side effects
page : Page Flags Model Msg
page =
    Page.element
        { init = init
        , update = update
        , subscriptions = subscriptions
        , view = view
        }
module Pages.SignIn exposing (page)

-- can read and update global state
page : Page Flags Model Msg
page =
    Page.component
        { init = init
        , update = update
        , subscriptions = subscriptions
        , view = view
        }

putting your pages together is super easy!

init : Route -> Global.Model -> ( Model, Cmd Msg, Cmd Global.Msg )
init route =
    case route of
        Route.Home -> pages.home.init ()
        Route.About -> pages.about.init ()
        Route.Posts slug -> pages.posts.init slug
        Route.SignIn -> pages.signIn.init ()
update : Msg -> Model -> Global.Model -> ( Model, Cmd Msg, Cmd Global.Msg )
update bigMsg bigModel =
    case ( bigMsg, bigModel ) of
        ( Home_Msg msg, Home_Model model ) ->
            pages.home.update msg model

        ( About_Msg msg, About_Model model ) ->
            pages.about.update msg model
      
        ( Posts_Msg msg, Posts_Model model ) ->
            pages.posts.update msg model
      
        ( SignIn_Msg msg, SignIn_Model model ) ->
            pages.signIn.update msg model

        _ ->
            always ( bigModel, Cmd.none, Cmd.none )
-- handle view and subscriptions in one case expression!
bundle : Model -> Global.Model -> { view : Document Msg, subscriptions : Sub Msg }
bundle bigModel =
    case route of
        Home_Model model -> pages.home.bundle model
        About_Model model -> pages.about.bundle model
        Posts_Model model -> pages.posts.bundle model
        SignIn_Model model -> pages.signIn.bundle model

install the npm package

The cli tool has commands like elm-spa init, elm-spa add, and elm-spa build for generating your routes and pages for you!

npm install -g elm-spa
elm-spa init new-project

install the elm package

If you'd rather define routes and pages by hand, you can add the elm package to your project:

elm install ryannhg/elm-spa

rather see an example?

This repo comes with an example project that you can play around with. add in some pages and see how it works!

git clone https://github.com/ryannhg/elm-spa
cd example
npm start