Liking cljdoc? Tell your friends :D
ClojureScript only.

cartoj.re-frame

Optional re-frame helpers for cartoj.

This namespace is NOT required by any other cartoj namespace — it is an add-on for anyone using re-frame as their state manager.

Provides:

  • ::set-view-state event handler — store a view-state map in app-db
  • ::view-state subscription — read the current view-state map
  • on-move-handler — returns an onMove callback that dispatches ::set-view-state

Usage (controlled map with re-frame):

;; In your event/sub registration (call once at app startup — these are ;; registered automatically when this namespace is required):

(require '[cartoj.re-frame :as cartoj-rf]) (require '[cartoj.core :as carto])

;; In your component: (let [vs @(rf/subscribe [::cartoj-rf/view-state])] [carto/map (merge vs {:on-move (cartoj-rf/on-move) :map-style "https://demotiles.maplibre.org/style.json"})])

Optional re-frame helpers for cartoj.

This namespace is NOT required by any other cartoj namespace — it is
an add-on for anyone using re-frame as their state manager.

Provides:
  - ::set-view-state  event handler — store a view-state map in app-db
  - ::view-state      subscription  — read the current view-state map
  - on-move-handler   — returns an onMove callback that dispatches ::set-view-state

Usage (controlled map with re-frame):

  ;; In your event/sub registration (call once at app startup — these are
  ;; registered automatically when this namespace is required):

  (require '[cartoj.re-frame :as cartoj-rf])
  (require '[cartoj.core     :as carto])

  ;; In your component:
  (let [vs @(rf/subscribe [::cartoj-rf/view-state])]
    [carto/map (merge vs
                      {:on-move  (cartoj-rf/on-move)
                       :map-style "https://demotiles.maplibre.org/style.json"})])
raw docstring

on-movecljs

(on-move)
(on-move {:keys [sync?] :or {sync? false}})

Returns an onMove callback suitable for passing as :on-move to cartoj.core/map.

Options (optional map): :sync? – when true, uses rf/dispatch-sync (default: false, uses rf/dispatch)

When called with a react-map-gl move event, it extracts the viewState JS object, converts it to a CLJS map via core/view-state->clj, and dispatches [::set-view-state view-state-map].

Example: [core/map {:on-move (cartoj-rf/on-move) :map-style "..."}]

Returns an onMove callback suitable for passing as :on-move to cartoj.core/map.

Options (optional map):
  :sync? – when true, uses rf/dispatch-sync (default: false, uses rf/dispatch)

When called with a react-map-gl move event, it extracts the viewState
JS object, converts it to a CLJS map via core/view-state->clj, and
dispatches [::set-view-state view-state-map].

Example:
  [core/map {:on-move (cartoj-rf/on-move) :map-style "..."}]
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close