Liking cljdoc? Tell your friends :D

reitit.frontend.easy

Easy wrapper over reitit.frontend.history, handling the state. Only one router can be active at a time.

Easy wrapper over reitit.frontend.history,
handling the state. Only one router can be active
at a time.

history

source

href

(href k)
(href k params)
(href k params query)
source

push-state

(push-state k)
(push-state k params)
(push-state k params query)

Sets the new route, leaving previous route in history.

Sets the new route, leaving previous route in history.
sourceraw docstring

replace-state

(replace-state k)
(replace-state k params)
(replace-state k params query)

Replaces current route. I.e. current route is not left on history.

Replaces current route. I.e. current route is not left on history.
sourceraw docstring

start!

(start! router on-navigate opts)

This registers event listeners on HTML5 history and hashchange events.

Automatically removes previous event listeners so it is safe to call this repeatedly, for example when using Figwheel or similar development workflow.

Parameters:

  • router The Reitit router.
  • on-navigate Function to be called when route changes. Takes two parameters, ´match´ and ´history´ object.

Options:

  • :use-fragment (default true) If true, onhashchange and location hash are used to store current route.

Options (Html5History):

  • :ignore-anchor-click? Function (router, event, anchor element, uri) which will be called to check if the anchor click event should be ignored. To extend built-in check, you can call reitit.frontend.history/ignore-anchor-click? function, which will ignore clicks if the href matches route tree.
This registers event listeners on HTML5 history and hashchange events.

Automatically removes previous event listeners so it is safe to call this repeatedly, for example when using
Figwheel or similar development workflow.

Parameters:
- router         The Reitit router.
- on-navigate    Function to be called when route changes. Takes two parameters, ´match´ and ´history´ object.

Options:
- :use-fragment  (default true) If true, onhashchange and location hash are used to store current route.

Options (Html5History):
- :ignore-anchor-click?  Function (router, event, anchor element, uri) which will be called to
                         check if the anchor click event should be ignored.
                         To extend built-in check, you can call `reitit.frontend.history/ignore-anchor-click?`
                         function, which will ignore clicks if the href matches route tree.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close