reagent-project /reagent
A minimalistic ClojureScript interface to React.js
★ 4,898⑂ 412👁 100⑃ 257● 409▤ 0
+1
Daily
4,898
stars
412
forks
100
watchers
257
prs
409
issues
0
releases
README
A simple ClojureScript interface to React.
Reagent provides a way to write efficient React components using (almost) nothing but plain ClojureScript functions.
Detailed intro with live examples
News
Documentation, latest release
Documentation, next release: API docs, Tutorials and FAQ
Community discussion and support channels
reagent channel in Clojure Slack
Commercial video material
Learn Reagent Free, Learn Reagent Pro (Affiliate link, $30 discount)
Learn Re-frame Free, Learn Re-frame Pro (Affiliate link, $30 discount)
purelyfunctional.tv
Lambda Island Videos
Usage
To use Reagent in an existing project you add this to your dependencies in project.clj:
And provide React using npm (when using e.g. Shadow-cljs)
npm i [email protected] [email protected]
If there is a more recent minor or patch version of React available, it should
be safe to use it in your application.
If you want to keep using React 18 or older versions, you can
also use cljsjs packages to provide React.
Reagent isn't tied to only React-dom but should work with other renderers also.
Examples
Reagent uses Hiccup-like markup instead of JSX. It looks like this:
clj
(defn some-component []
[:div
[:h3 "I am a component!"]
[:p.someclass
"I have " [:strong "bold"]
[:span {:style {:color "red"}} " and red"]
" text."]])
Since version 0.8: The :class attribute also supports collections of classes, and nil values are removed:
clj
[:div {:class ["a-class" (when active? "active") "b-class"]}]
You can use one component inside another:
clj
(defn calling-component []
[:div "Parent component"
[some-component]])
And pass properties from one component to another:
clj
(defn child [name]
[:p "Hi, I am " name])
(defn parent []
[child "Foo Bar"])
You mount the component into the DOM like this:
clj
(defn mount-it []
(rd/render [parent] (.-body js/document)))
assuming we have imported Reagent like this:
clj
(ns example
(:require [reagent.core :as r]
[reagent.dom :as rd]))
State is handled using Reagent's version of atom, like this:
clj
(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 to 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:
clj
(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:
Top issues
#244cursor watch not triggering when base atom is swapped.9 comments · 2016-06-04#592Document providing custom p/Compiler implementation8 comments · 2023-06-13#302Add a guide to the docs6 comments · 2017-06-04#545RFC: Provide a React hook for using ratoms/reactions as part of public API5 comments · 2021-08-11#327Create performance benchmarks5 comments · 2017-11-28#361self-hosted clojurescript4 comments · 2018-04-07#568Reaction value propagation glitch - the dirty flag is not set3 comments · 2022-06-13#421react-devtools for Reagent?3 comments · 2019-01-29
Discussions
#611React 18 support plans3 comments · 2024-11-08#599dom-node deprecation1 comments · 2023-12-11#620Find a way to make Hiccup forms easier to analyze4 comments · 2020-12-22#618Consider decoupling Reagent from React45 comments · 2016-10-21#625Server-side rendering using JVM Clojure11 comments · 2016-06-10