ryannhg/elm-spa
1
1
Fork 0
mirror of https://github.com/ryannhg/elm-spa.git synced 2024-11-22 09:44:55 +03:00
Code Issues Packages Projects Releases Wiki Activity

add docs for programmatic navigation

Browse Source
This commit is contained in:
Ryan Haskell-Glatz 2020-07-14 10:23:08 -05:00 committed by GitHub
parent 1d0b5080b1
commit 3a9b762608
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
examples/elm-spa-dev/public/content/guide/routing.md
View File

@ -112,6 +112,40 @@ Required for programmatic navigation with `Nav.pushUrl` and other functions from
The original URL in case you need any other information like the protocol, port, etc.
## Programmatic Navigation
The [elm/browser](https://package.elm-lang.org/packages/elm/browser/latest/Browser-Navigation#pushUrl) allows us to programmatically navigate to another page, if we provide a `Browser.Navigation.Key`. Fortunately, the `Url params` record above contains that `key`, and is available on all pages (and the `Shared` module)!
I recommend creating a common module, like `Utils.Route` that you can use in your application:
```elm
module Utils.Route exposing (navigate)
import Browser.Navigation as Nav
import Spa.Generated.Route as Route exposing (Route)
navigate : Nav.Key -> Route -> Cmd msg
navigate key route =
Nav.pushUrl key (Route.toString route)
```
From there, you can call `Utils.Route.navigate` from any `init` or `update` function with your desired route.
```elm
module Pages.Dashboard exposing (..)
import Utils.Route
-- ...
init : Url Params -> ( Model, Cmd Msg )
init url =
( Model { ... }
, Utils.Route.navigate url.key Route.SignIn
)
```
---
Let's take a closer look at [Pages](/guide/pages)!
Let's take a closer look at [Pages](/guide/pages)!