README.md

Helix

ClojureScript optimized for modern React development.

(ns my-app.core
  (:require [helix.core :refer [defnc $]]
            [helix.hooks :as hooks]
            [helix.dom :as d]
            ["react-dom/client" :as rdom]))

;; define components using the `defnc` macro
(defnc greeting
  "A component which greets a user."
  [{:keys [name]}]
  ;; use helix.dom to create DOM elements
  (d/div "Hello, " (d/strong name) "!"))

(defnc app []
  (let [[state set-state] (hooks/use-state {:name "Helix User"})]
    (d/div
     (d/h1 "Welcome!")
      ;; create elements out of components
      ($ greeting {:name (:name state)})
      (d/input {:value (:name state)
                :on-change #(set-state assoc :name (.. % -target -value))}))))

;; start your app with your favorite React renderer
(defonce root (rdom/createRoot (js/document.getElementById "app")))
(.render root ($ app))

Installation

Install the latest version from clojars in your project.

Install JS dependencies:

npm init # initialize NPM project if necessary
npm i react react-refresh # install react, and react-refresh for hot reloading support (see docs)
npm i react-dom # install renderer. alternatives could be react-native, react-three-fiber, etc.

shadow-cljs and react-native

See React Native.

lein-cljsbuild / figwheel-main / raw CLJS

Use CLJSJS or package react yourself using webpack, ensuring it is provided as the name "react".

Documentation

View formatted docs at

• Why Helix
• Creating Components
  • Props
  • Interop
  • Higher-order Components
  • Class Components (WIP)
• Creating elements
  • $ macro
    • Native elements and props
    • Dynamic props
  • helix.dom
  • Other helpful tools
    • Fragments
    • Context providers
    • Suspense boundaries
    • Creating elements dynamically
    • Factory functions
• Hooks
  • Maintaining state
    • Reducers
    • Refs
  • Doing side effects
  • Optimizations
  • Other miscellaneous
• Experiments
  • Define as factory function
  • Detect invalid hooks usage
  • Fast Refresh
  • Metadata Optimizations
• Pro-tips
  • Memoizing components
  • Don't use deep equals
  • Create a custom macro
• Frequently Asked Questions
  • What about hx?
  • What about hiccup?
• React Native

Other resources:

• #helix Slack channel (Sign up for Slack here)

Related projects and repos

• Example TodoMVC
• Example repo running tests using testing-library and jsdom
• Examples from the React docs site rewritten in helix

Companies using it

License

Copyright © 2023 Will Acton

Distributed under the EPL 2.0