ty.router — dev.gersak/ty 0.3.1

Simple router for ty web components using zipper-based tree structure

*permissions* cljs

*roles* cljs

*router* cljs

*user* cljs

authorized? cljs

(authorized? component-id)

Check if user can access component

clj->query cljs

(clj->query data)

Convert clojure map to URLSearchParams string

component->location cljs

(component->location tree id)

Find component by id in tree, return zipper location

component-path cljs

(component-path tree id)

Build URL path from root to component, including hash fragment if present

component-tree-zipper cljs

(component-tree-zipper root)

Returns routing tree zipper

exact-match? cljs

(exact-match? tree current-url component-id)

Compare current URL with component path, including hash fragments

get-current-url cljs

(get-current-url)

Get current full URL including hash

handle-landing! cljs

(handle-landing!)

Check if current location should trigger landing redirect. Always runs - redirects to best available route for 404s or auth failures.

init! cljs

(init!)

(init! base)

Initialize router with browser events and smart landing redirects

landing-candidates cljs

(landing-candidates)

Get current landing candidates for debugging

link cljs

(link parent children)

Add component(s) to router tree under parent. Parent should be a component id. Children can be a single component map or a vector of component maps.

maybe-add-base cljs

(maybe-add-base base url)

For given base and url will add base prefix if it exists to url. If base is nil than URL is returned

maybe-remove-base cljs

(maybe-remove-base base url)

For given base and url will return URL without base. If base is nil function will return URL immediately

navigate! cljs

(navigate! route-id)

(navigate! route-id params)

Navigate to a route by id with optional query params

on-path? cljs

(on-path? tree path id)

For given path and component id function will get component path and check if given path starts with component path.

If it does, than component is on path (true)

parse-url cljs

(parse-url url)

Parse URL into path and hash components

query->clj cljs

(query->clj qp)

Convert URLSearchParams to clojure map

query-params cljs

(query-params)

Get current query parameters as a map

rendered? cljs

(rendered? component-id)

(rendered? component-id exact?)

Check if component is on current path

set-component cljs

(set-component tree {:keys [id parent] :as component})

Function used to add component to component tree. For given component tree add component by specifying component id and component parent.

set-query! cljs

(set-query! params)

(set-query! params action)

Set query parameters. Action can be :replace (default) or :push

update-router-from-browser! cljs

(update-router-from-browser! base)

Update router state from current browser URL

url->components cljs

(url->components)

(url->components url)

(url->components tree url)

Returns all components that are rendered for given URL