Liking cljdoc? Tell your friends :D

reitit.frontend.history

Provides integration to hash-change or HTML5 History events.

Provides integration to hash-change or HTML5 History
events.

FragmentHistory

source

Historyprotocol

-get-path
(-get-path this)
-href
(-href this path)
-init
(-init this)

Create event listeners

Create event listeners

-on-navigate
(-on-navigate this path)
-stop
(-stop this)

Remove event listeners

Remove event listeners

source

href

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

Html5History

source

ignore-anchor-click?

(ignore-anchor-click? router e el uri)

Precicate to check if the anchor click event default action should be ignored. This logic will ignore the event if anchor href matches the route tree, and in this case the page location is updated using History API.

Precicate to check if the anchor click event default action
should be ignored. This logic will ignore the event
if anchor href matches the route tree, and in this case
the page location is updated using History API.
sourceraw docstring

push-state

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

Updates the browser URL and pushes new entry to the history stack using 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 URL and pushes new entry to the history stack using
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 history name)
(replace-state history name path-params)
(replace-state history 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)
(start! router
        on-navigate
        {:keys [use-fragment], :or {use-fragment true}, :as opts})

This registers event listeners on HTML5 history and hashchange events.

Returns History object.

When using with development workflow like Figwheel, remember to remove listeners using stop! call before calling start! again.

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.

Returns History object.

When using with development workflow like Figwheel, remember to
remove listeners using stop! call before calling start! again.

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

stop!

(stop! history)

Stops the given history handler, removing the event handlers.

Stops the given history handler, removing the event handlers.
sourceraw docstring

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

× close