A minimalistic ClojureScript interface to React.js http://reagent-project.github.io/
Go to file
Daniel Compton 956f4dc1dc
Reformat code examples for using an entity
2019-12-28 09:43:50 +13:00
.github Update template words 2016-05-20 11:01:33 +10:00
demo Update react documentation links in intro.cljs 2019-06-30 17:55:03 -04:00
doc Reformat code examples for using an entity 2019-12-28 09:43:50 +13:00
examples Clean unncessary type tag 2019-09-12 11:26:16 +03:00
lib Make it easier to use with webpack and node 2015-10-10 13:40:33 +02:00
outsite/public Use a README instead .keep for gh-pages 2015-02-09 15:02:16 +01:00
prerender/sitetools Remove old require from demo site code 2018-12-31 15:46:34 +02:00
site/public Make h2 bigger 2015-12-21 08:14:11 +01:00
src Remove old comment 2019-12-17 23:46:15 +02:00
test Extern fix for npm prod build 2019-12-17 02:58:38 +02:00
test-environments Add shadow-cljs test configuration 2019-10-25 10:28:52 +03:00
.gitignore Add shadow-cljs test configuration 2019-10-25 10:28:52 +03:00
CHANGELOG.md Release 0.9.0-rc4 2019-12-17 03:02:49 +02:00
CONTRIBUTING.md Fix bad development doc link in CONTRIBUTING.md 2019-06-30 17:57:02 -04:00
LICENSE Rename LICENSE.md to LICENSE 2017-10-27 11:04:15 +03:00
README.md Update README.md 2019-11-24 16:24:45 +02:00
build-docs.sh Deploy site and docs from CircleCI 2018-04-16 19:52:47 +03:00
build-example-site.sh Try fixing docs/master build 2018-05-17 08:59:18 +03:00
circle.yml Add tag filter for test job to enable tag builds 2018-05-17 09:06:54 +03:00
logo.png Add logo as svg file 2018-11-14 23:38:13 +02:00
logo.svg Add logo as svg file 2018-11-14 23:38:13 +02:00
package-lock.json Update cljs and shadow-cljs 2019-12-17 02:39:44 +02:00
package.json Update cljs and shadow-cljs 2019-12-17 02:39:44 +02:00
prepare-tests.sh Use React 16 and simplify test setup 2018-04-03 10:33:01 +03:00
project.clj Release 0.9.0-rc4 2019-12-17 03:02:49 +02:00
run-tests.sh Use React 16 and simplify test setup 2018-04-03 10:33:01 +03:00
shadow-cljs.edn Add shadow-cljs dev setup 2019-11-19 21:57:21 +02:00

README.md

Reagent

Reagent-Project

A simple ClojureScript interface to React.

Reagent provides a way to write efficient React components using (almost) nothing but plain ClojureScript functions.

Usage

To create a new Reagent project using Leiningen template simply run:

lein new reagent myproject

If you wish to only create the assets for ClojureScript without a Clojure backend then do the following instead:

lein new reagent-frontend myproject

This will setup a new Reagent project with some reasonable defaults, see here for more details.

To use Reagent in an existing project you add this to your dependencies in project.clj:

Clojars Project
CircleCI

This is all you need to do if you want the standard version of React. If you want to use your own build of React (or React from a CDN), you have to use :exclusions variant of the dependency, and also provide react and react-dom namespaces (by creating .cljs files with just ns form, or by adding your own :foreign-libs entries).

[reagent "0.x.x" :exclusions [cljsjs/react cljsjs/react-dom]]

Examples

Reagent uses Hiccup-like markup instead of React's sort-of html. It looks like this:

(defn some-component []
  [:div
   [:h3 "I am a component!"]
   [:p.someclass
    "I have " [:strong "bold"]
    [:span {:style {:color "red"}} " and red"]
    " text."]])

Reagent extends standard Hiccup in one way: it is possible to "squeeze" elements together by using a > character.

[:div
  [:p
    [:b "Nested Element"]]]

can be written as:

[:div>p>b "Nested Element"]

Since version 0.8: The :class attribute also supports collections of classes, and nil values are removed:

[:div {:class ["a-class" (when active? "active") "b-class"]}]

You can use one component inside another:

(defn calling-component []
  [:div "Parent component"
   [some-component]])

And pass properties from one component to another:

(defn child [name]
  [:p "Hi, I am " name])

(defn childcaller []
  [child "Foo Bar"])

You mount the component into the DOM like this:

(defn mountit []
  (r/render [childcaller]
            (.-body js/document)))

assuming we have imported Reagent like this:

(ns example
  (:require [reagent.core :as r]))

State is handled using Reagent's version of atom, like this:

(defonce click-count (r/atom 0))

(defn state-ful-with-atom []
  [:div {:on-click #(swap! click-count inc)}
   "I have been clicked " @click-count " times."])

Any component that dereferences a reagent.core/atom will be automatically re-rendered.

If you want do some setting up when the component is first created, the component function can return a new function that will be called to do the actual rendering:

(defn timer-component []
  (let [seconds-elapsed (r/atom 0)]
    (fn []
      (js/setTimeout #(swap! seconds-elapsed inc) 1000)
      [:div
       "Seconds Elapsed: " @seconds-elapsed])))

This way you can avoid using React's lifecycle callbacks like getInitialState and componentWillMount most of the time.

But you can still use them if you want to, either using reagent.core/create-class or by attaching meta-data to a component function:

(defonce my-html (r/atom ""))

(defn plain-component []
  [:p "My html is " @my-html])

(def component-with-callback
  (with-meta plain-component
    {:component-did-mount
     (fn [this]
       (reset! my-html (.-innerHTML (reagent/dom-node this))))}))

See the examples directory for more examples.

Performance

React is pretty darn fast, and so is Reagent. It should even be faster than plain old javascript React a lot of the time, since ClojureScript allows us to skip a lot of unnecessary rendering (through judicious use of React's shouldComponentUpdate).

The ClojureScript overhead is kept down, thanks to lots of caching.

Code size is a little bigger than React.js, but still quite small. The todomvc example clocks in at roughly 79K gzipped, using advanced compilation.

About

The idea and some of the code for making components atom-like comes from pump. The reactive-atom idea (and some code) comes from reflex.

The license is MIT.