Reagent
GuideAPIChangelogGitHub
  • Documentation index
  • Getting Started
  • Reagent 2
    • What's new in 2.0
    • Upgrading to 2.0
  • Learn
    • Using Hiccup to Describe HTML
    • Creating Reagent Components
    • Square brackets vs parentheses
    • When do components update?
    • Managing State
    • Batching and Timing
    • Controlled Inputs
    • Best Practices (draft)
  • Reference
    • Interop with React
    • React Features
    • Reagent Compiler
    • Web Components (Custom Elements)
    • React Renderers
    • Server Side Rendering
    • React 19 and Reagent
    • Security
  • FAQ
    • Component not re-rendering
    • Using refs
    • Entities like nbsp
    • HTML entities
    • Missing attributes
    • dangerouslySetInnerHTML
    • Forcing re-creation
    • Broken after updating deps
  • Older versions
    • Upgrading to 1.2
    • Upgrading to 1.1
    • Upgrading to 1.0
    • Upgrading to 0.8
  • More
    • Example: Material-UI
    • Example: Smooth UI
    • Development guide
  • API
    • API reference
    • reagent.core
    • reagent.dom.client
    • reagent.dom
    • reagent.dom.server
    • reagent.ratom
    • reagent.hooks

API reference

Generated from the docstrings in the current Reagent source. API docs for each released version are on the versioned API docs and on cljdoc.

reagent.core

Components, Reagent atoms, cursors, reactions and React interop.

adapt-react-classafter-renderargvas-elementatomchildrenclass-namescreate-classcreate-compilercreate-elementcurrent-componentcursordefcdispose!flushforce-updateis-clientmerge-propsnext-tickpartialpropsreactify-componentreactionrenderreplace-staterswap!set-default-compiler!set-statestatestate-atomtracktrack!unsafe-htmlwith-letwrap

reagent.dom.client

Render into React roots (React 18 and 19).

create-roothydrate-rootrenderunmount

reagent.dom

Legacy ReactDOM render API.

force-update-allrenderunmount-component-at-node

reagent.dom.server

Render components to HTML strings for server-side rendering.

render-to-static-markuprender-to-string

reagent.ratom

Reactive atoms, reactions and tracking.

IDisposableIReactiveAtomIRunnableatomcheck-derefscursordebugflush!make-reactionmake-trackmake-track!make-wrapperreactionreactive?run!run-in-reactionrunningtracktrack!with-letwith-let-destroywith-let-values

reagent.hooks

React hooks that use Clojure value equality for deps and state.

use-action-stateuse-callbackuse-clj-depsuse-contextuse-debug-valueuse-deferred-valueuse-effectuse-iduse-imperative-handleuse-layout-effectuse-memouse-optimisticuse-reduceruse-refuse-stateuse-sync-external-storeuse-transitionwith-return-value-check
GitHub · cljdoc · #reagent on Clojurians Slack · Archive