Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 2.46 KB

README.md

File metadata and controls

81 lines (56 loc) · 2.46 KB
Raw

refx

Build Status cljdoc Clojars

re-frame port using React hooks instead of Reagent.

Designed to be used with Helix or UIx.

Status

This library is in alpha state. While most of the code was copied directly from re-frame, and should be pretty stable, refx's additions need more testing, and the API might still change drastically.

Installation

Releases are available from Clojars.

deps.edn:

com.fbeyer/refx {:mvn/version "0.0.49"}

Leiningen/Boot:

[com.fbeyer/refx "0.0.49"]

You can use also use the Git coordinate:

{:deps {refx.core {:git/url "https://github.com/ferdinand-beyer/refx.git"
                   :git/sha "COMMIT_SHA"
                   :deps/root "core"}}}

Rationale

See this blog post for an explanation why I started working on refx.

Differences from re-frame

  • subscribe has been replaced with two functions:
    • sub returns a subscription signal, to be used in input functions in reg-sub
    • use-sub is a React hook that return's a subscription's value. These are not atoms and don't need to be dereferenced.
  • query vectors with sub and use-sub do not support the rarely used extra dyn-v argument. See the next point for a superior alternative.
  • query vectors can contain signals returned by sub for dynamic subscriptions
  • subscriptions support other signals than app-db as input. Anything that satisfies the ISignal protocol, which includes atoms.

Examples

See the examples directory for re-frame's todomvc, implemented with Helix and UIx.

License

Distributed under the MIT License.
Copyright © 2022 Ferdinand Beyer

This software uses third-party open-source software.
See NOTICE for individual copyright and license notices.