hyperfiddle.router3 — com.hyperfiddle/electric v3-alpha-4-g9948fc0b

A reactive tree router

adaptive-key clj

(adaptive-key key)

Return a lens focusing on the value at key in an associative data structure. When updating the focused value by a function f:

• if value is a map, then the result is equivalent to {key (f value)} (trivial case),
• if value is vector, then key must be a natural integer. The value at position key will be updated by f. If key is out of the array upper bound, the vector will be resized and padded with nil .
• if value is neither a map nor a vector, then value will become {value (f nil)}.
• if value is nil:
  • if key is a natural integer, then value will default to a vector,
  • otherwise value will default to a map.

as-vec clj

(as-vec x)

confirm-navigation? clj

A predicate called on user navigation intent. If false, the current navigation intent is prevented. Called during DOM event bubbling phase, it must be synchronous and therefore must be bound to a clojure function.

current-path clj

(current-path paths)

Current-route? clj

(Current-route? target-route)

current-route? clj

decode clj

decode* clj

(decode* path)

encode clj

encode* clj

(encode* route)

focus clj macro

(focus path & body)

Focus clj

(Focus path Body-fn)

HTML5-History clj

(HTML5-History)

HTML5-Navigation-Intents clj

(HTML5-Navigation-Intents history)

id-lens clj

identity-setter clj

(identity-setter structure f)

key-lens clj

(key-lens key)

lens clj

(lens getter-f setter-f)

Link clj

(Link path Body)

link clj macro

(link path & body)

Navigate! clj

(Navigate! path)

normalize clj

(normalize x)

normalize-route-value clj

(normalize-route-value x)

OnBeforeNavigate! clj

(OnBeforeNavigate!)

Run for effect on history navigation

OnNavigate clj

(OnNavigate Callback)

(OnNavigate node Callback)

Will call Callback on internal router/Link click. Callback takes 2 arguments:

• the route to navigate to
• the dom click js event.

over clj

(over lens f structure)

pad clj

(pad n coll)

path clj

The current path

path-lens clj

(path-lens path)

Given a sequence of keys in an associative data structure (e.g. [:foo :bar 0 :baz]), return a lens focusing on the value at the end of the path. An empty path (e.g. []) is an identity.

paths clj

A stack of paths

ReplaceState! clj

(ReplaceState! path)

resolve-path clj

(resolve-path path)

(resolve-path stack [x & xs])

Given a path eventually containing relative path components (e.g. '., '.., or '/), resolve the final path.

• . is a noop,
• .. navigates one level up,
• / navigates to the root. e.g. [:foo '. :bar] => [:foo :bar] [:foo '. '. :bar] => [:foo :bar] [:foo :bar '..] => [:foo] [:foo :bar '.. :baz] => [:foo :baz] ['.. :foo] => [:foo] ['/] => [] [:foo '/] => [] [:foo :bar '/ :baz] => [:baz]

root-route clj

Top level route

route clj

Current rout in the scope of a router

Route-at clj

(Route-at path)

Route-for clj

(Route-for path)

(Route-for path value)

Router clj

(Router history BodyFn)

router clj macro

(router history & body)

safe-pop clj

(safe-pop coll)

set clj

(set lens value structure)

set-key clj

(set-key m old-key new-key)

Replaces old-key in map m by new-key without altering the corresponding value. Similar to clojure.set/rename-keys, but faster and for a single key.

simplify clj

(simplify route)

split-link-path clj

(split-link-path path)

update-key clj

(update-key m k f)

Update a key in a map. Replaces key k in map m by the result of (f k). The corresponding value is preserved.

view clj

(view lens structure)