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 name)
(href name path-params)
(href name path-params query-params)

Generate a URL for a route defined by name, with given path-params and query-params.

The URL is formatted using Reitit frontend history handler, so using it with anchor element href will correctly trigger route change event.

Note: currently collections in query-parameters are encoded as field-value pairs separated by &, i.e. "?a=1&a=2", if you want to encode them differently, convert the collections to strings first.

Generate a URL for a route defined by name, with given path-params and query-params.

The URL is formatted using Reitit frontend history handler, so using it with
anchor element href will correctly trigger route change event.

Note: currently collections in query-parameters are encoded as field-value
pairs separated by &, i.e. "?a=1&a=2", if you want to encode them
differently, convert the collections to strings first.
sourceraw docstring

push-state

(push-state name)
(push-state name path-params)
(push-state name path-params query-params)

Updates the browser location and pushes new entry to the history stack using URL built from a route defined by name, with given path-params and query-params.

Will also trigger on-navigate callback on Reitit frontend History handler.

Note: currently collections in query parameters are encoded as field-value pairs separated by &, i.e. "?a=1&a=2", if you want to encode them differently, convert the collections to strings first.

See also: https://developer.mozilla.org/en-US/docs/Web/API/History/pushState

Updates the browser location and pushes new entry to the history stack using
URL built from a route defined by name, with given path-params and
query-params.

Will also trigger on-navigate callback on Reitit frontend History handler.

Note: currently collections in query parameters are encoded as field-value
pairs separated by &, i.e. "?a=1&a=2", if you want to encode them
differently, convert the collections to strings first.

See also:
https://developer.mozilla.org/en-US/docs/Web/API/History/pushState
sourceraw docstring

replace-state

(replace-state name)
(replace-state name path-params)
(replace-state name path-params query-params)

Updates the browser location and replaces latest entry in the history stack using URL built from a route defined by name, with given path-params and query-params.

Will also trigger on-navigate callback on Reitit frontend History handler.

Note: currently collections in query-parameters are encoded as field-value pairs separated by &, i.e. "?a=1&a=2", if you want to encode them differently, convert the collections to strings first.

See also: https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState

Updates the browser location and replaces latest entry in the history stack
using URL built from a route defined by name, with given path-params and
query-params.

Will also trigger on-navigate callback on Reitit frontend History handler.

Note: currently collections in query-parameters are encoded as field-value
pairs separated by &, i.e. "?a=1&a=2", if you want to encode them
differently, convert the collections to strings first.

See also:
https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState
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