luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2026-01-28 09:00:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean frontend routing docstrings

Browse source
This commit is contained in:
Juho Teperi 2018-08-27 14:22:21 +03:00
parent 9729a7424e
commit b99e25ef4f
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
modules/reitit-frontend/src/reitit/frontend/easy.cljs
View file

@ -15,15 +15,15 @@
remove listeners using stop! call before calling start! again. remove listeners using stop! call before calling start! again.
Parameters: Parameters:
- router The Reitit routing tree. - router The Reitit router.
- on-navigate Function to be called when route changes. Takes two parameters, ´token´ and ´history´ object. - on-navigate Function to be called when route changes. Takes two parameters, ´match´ and ´history´ object.
Options: Options:
- :use-fragment (default true) If true, onhashchange and location hash are used to store the token." - :use-fragment (default true) If true, onhashchange and location hash are used to store the token."
[routes on-navigate opts] [router on-navigate opts]
(swap! history (fn [old-history] (swap! history (fn [old-history]
(rfh/stop! old-history) (rfh/stop! old-history)
(rfh/start! routes on-navigate opts)))) (rfh/start! router on-navigate opts))))
(defn href (defn href
([k] ([k]

5
modules/reitit-frontend/src/reitit/frontend/history.cljs
View file

@ -102,11 +102,14 @@
(defn start! (defn start!
"This registers event listeners on HTML5 history and hashchange events. "This registers event listeners on HTML5 history and hashchange events.
Returns History object.
When using with development workflow like Figwheel, rememeber to When using with development workflow like Figwheel, rememeber to
remove listeners using stop! call before calling start! again. remove listeners using stop! call before calling start! again.
Parameters: Parameters:
- router The Reitit routing tree. - router The Reitit router.
- on-navigate Function to be called when route changes. Takes two parameters, ´match´ and ´history´ object. - on-navigate Function to be called when route changes. Takes two parameters, ´match´ and ´history´ object.
Options: Options: