reflet.core — io.zalky/reflet 0.3.0-rc1

cljs

Reflet API and convenience utilities.

cleanup cljs multimethod

Dispatches on the ref's unique attribute.

cleanup-interceptors cljs

clear-stale-vars! clj/s macro

(clear-stale-vars!)

Clear stale descriptions during hot-reloading. Not needed for production builds. Currently only works with shadow-cljs.

clear-stale-vars-impl! clj/s macro

(clear-stale-vars-impl!)

Do not call directly.

debounced-events cljs

debug-context clj

(debug-context env opts)

debug? cljs

(debug?)

Returns true if debugging is activated.

desc cljs

(desc query-v)

disp cljs

disp-debounced cljs

(disp-debounced {[id :as event] :dispatch ms :ms})

Debounces dispatched events by id.

disp-sync cljs

once clj/s macro

(once & forms)

prevent-default cljs

(prevent-default f)

props-did-update-handler cljs

(props-did-update-handler f)

Given an update handler, f, returns a componentDidUpdate lifecycle handler function that will invoke the provided fn with old and new component props when they change. The given handler, f ,must be a function of two arguments, the old props value, and the new props value. Careful, other lifecycles have different signatures with respect to new and old values during an update, and are not interchangeable.

props-handler cljs

(props-handler f)

Given an update handler, f, that accepts a single component argument, returns lifecycle handler function that will invoke the provided fn with component props. Careful, other lifecycles have different signatures with respect to new and old values during an update, and are not interchangeable.

pull-fx cljs multimethod

pull-reaction cljs

(pull-reaction [id :as query-v])

(pull-reaction expr-fn query-v)

reflet-interceptors cljs

reg-comp cljs

(reg-comp id comp-ids)

Composes a series of named, graph reactions, where the result of each reaction in the sequence is provided as input to the next. Semantics are similar to clojure.core/comp. Except for the first, every other reaction in the pipeline should expect only a single argument. As with comp, the order of operations is reversed from the order in which they are declared. The resultant reaction returned by the composition is cached according to the input arguments of the pipeline. No intermediary reactions are cached. Does not currently work with entity descriptions.

reg-desc clj/s macro

(reg-desc id desc)

Registers an entity description. See wiki for full details. Macro prevents list evaluation, part of the grammar for pull fx. Registers a var symbol for each description so that stale descriptions can be removed on hot reload.

reg-desc-impl cljs

(reg-desc-impl id desc)

Do not use, see reg-desc macro.

reg-event-ctx cljs

(reg-event-ctx id handler)

(reg-event-ctx id interceptors handler)

reg-event-db cljs

(reg-event-db id handler)

(reg-event-db id interceptors handler)

reg-event-fx cljs

(reg-event-fx id handler)

(reg-event-fx id interceptors handler)

reg-no-op cljs

(reg-no-op & ids)

Convenience function for declaring no-op events.

reg-pull clj/s macro

(reg-pull & [id [_ bindings & spec] result-fn])

Registers a named pull query. Semantics are similar to Datomic pull, but with link and attribute queries. See wiki for full details. Macro prevents list evaluation, part of the grammar for pull fx.

reg-pull-impl cljs

(reg-pull-impl id expr-fn)

(reg-pull-impl id expr-fn result-fn)

Do not use, see reg-pull macro.

reg-sub cljs

reg-sub-raw cljs

remove-desc cljs

(remove-desc id)

Manually removes a descriptions from the global description registry. Similar to clojure.core/remove-method. If you're using shadow-cljs and have configured hot-reloading as described in the description wiki, Reflet will automatically clear stale descriptions and you should never have to use this function. This should also be unnecessary in production builds.

result-reaction cljs

(result-reaction input-r [id :as query-v])

shadow-cljs? clj

(shadow-cljs?)

stop-prop cljs

(stop-prop f)

sub cljs

with-ref clj/s macro

(with-ref bindings & body)

Generates entity references. Optionally rebinds props attributes, and dispatches entity cleanup. See the Reflet wiki for motivation, usage and documentation of other options.

with-ref* clj/s macro

(with-ref* bindings & body)

Like with-ref but with debug implicitly disabled. Used to implement the debug UI. Not for public use: throws an error if used outside of a reflet.debug.* namespace.