A minimalistic ClojureScript interface to React.js http://reagent-project.github.io/
Go to file
Dan Holmsand 5fa400c86a Fix line break 2014-01-09 15:38:16 +01:00
bin Improve demo a bit 2014-01-09 14:37:11 +01:00
bower_components/react Update React to 0.8.0 2014-01-03 16:54:38 +01:00
examples More cleanup 2014-01-08 16:34:36 +01:00
site Improve demo a bit 2014-01-09 14:37:11 +01:00
src/cloact Fix line break 2014-01-09 15:38:16 +01:00
test Improve demo a bit 2014-01-09 14:37:11 +01:00
.gitignore Fix line break 2014-01-09 15:38:16 +01:00
Makefile Generate demo page 2014-01-05 11:16:01 +01:00
README.md Breaking change: Stop implementing IDeref in cloact components 2014-01-07 19:57:40 +01:00
project.clj Clean project.clj up 2014-01-07 20:04:49 +01:00

README.md

Cloact

A simple ClojureScript interface to React.

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

To use Cloact you just add this to your project.clj:

[cloact "0.0.3"]

Examples

Cloact 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."]])

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 [props]
  [:p "Hi, I am "
   (:name props)])

(defn childcaller []
  [child {:name "Foo"}])

You mount the component into the DOM like this:

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

assuming we have imported Cloact like this:

(ns example
  (:require [cloact.core :as cloact :refer [atom]]))

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

(def click-count (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 cloact.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 (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 cloact.core/create-class or by attaching meta-data to a component function:

(def my-html (atom ""))

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

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

See the examples directory for more examples.

Performance

React is pretty darn fast, and so is Cloact. 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 56K 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.