reagent/doc/ReactFeatures.md

3.0 KiB

React Features

Most React features should be usable from Reagent, even if Reagent doesn't provide functions to use them directly.

Fragments

JSX:

function example() {
  return (
    <React.Fragment>
      <ChildA />
      <ChildB />
      <ChildC />
    </React.Fragment>
  );
}

Reagent:

(defn example []
  [:<>
   [child-a]
   [child-b]
   [child-c]])

Reagent syntax follows React Fragment short syntax.

Context

(defonce my-context (react/createContext "default"))

(def Provider (.-Provider my-context))
(def Consumer (.-Consumer my-context))

(r/render [:> Provider {:value "bar"}
           [:> Consumer {}
            (fn [v]
              (r/as-element [:div "Context: " v]))]]
          container)

Tests contain example of using old React lifecycle Context API (context-wrapper function): tests

Error boundaries

You can use ComponentDidCatch lifecycle method with create-class:

(defn error-boundary [comp]
  (r/create-class
    {:component-did-catch (fn [this e info]
                            (reset! error e))
     :reagent-render (fn [comp]
                        (if @error
                          [:div
                           "Something went wrong."
                           [:button {:on-click #(reset! error nil)} "Try again"]]
                          comp))}))

Hooks

Hooks can't be used inside class components, and Reagent implementation creates a class component from every function (i.e. Reagent component).

However, you can use React components using Hooks inside Reagent, or use hx components inside Reagent. Also, it is possible to create React components from Reagent quite easily, because React function component is just a function that happens to return React elements, and r/as-element does just that:

;; This is React function component. Can't use Ratoms here!
(defn example []
  (let [[count set-count] (react/useState 0)]
    (r/as-element
      [:div
       [:p "You clicked " count " times"]
       [:button
        {:on-click #(set-count inc)}
        "Click"]])))

;; Reagent component
(defn reagent-component []
  [:div
   ;; Note :> to use a function as React component
   [:> example]])

If you need to pass RAtom state into these components, dereference them in the Reagent components and pass the value (and if needed, function to update them) as properties into the React function component.

Portals

(defn reagent-component []
  (r/create-class
    {:render (fn [this]
               (let [el (.. js/document (getElementById "portal-el"))]
                 (react-dom/createPortal (r/as-element [:div "foo"]) el)))}))

TODO: Can this be done without create-class and :render. TODO: This might have problems handling Ratoms, test.

Hydrate

(react-dom/hydrate (r/as-element [main-component]) container)