com.fulcrologic.fulcro.react.hooks — com.fulcrologic/fulcro 3.4.3

Simple wrappers for React hooks support, along with additional predefined functions that do useful things with hooks in the context of Fulcro.

use-callback clj/s

(use-callback cb)

(use-callback cb args)

A simple wrapper around React/useCallback. Converts args to js array before send.

React docs: https://reactjs.org/docs/hooks-reference.html#usecallback

use-context clj/s

(use-context ctx)

A simple wrapper around React/useContext.

use-debug-value clj/s

(use-debug-value value)

(use-debug-value value formatter)

A simple wrapper around React/useDebugValue.

React docs: https://reactjs.org/docs/hooks-reference.html#uselayouteffect

use-effect clj/s macro

(use-effect f)

(use-effect f dependencies)

A simple macro wrapper around React/useEffect that does compile-time conversion of dependencies to a js-array for convenience without affecting performance.

React docs: https://reactjs.org/docs/hooks-reference.html#useeffect

use-fulcro-mount clj/s

(use-fulcro-mount parent-this {:keys [child-class initial-state-params]})

Generate a new sub-root.

;; important, you must use hooks (`defhc` or `:use-hooks? true`)
(defsc NewRoot [this props]
  {:use-hooks? true}
  (let [f (use-fulcro-mount this {:child-class SomeChild})]
    ;; parent props will show up in SomeChild as computed props.
    (f props)))

WARNING: Requires you use multi-root-renderer.

use-gc clj/s

(use-gc this-or-app ident edges)

Effect handler. Creates an effect that will garbage-collect the given ident from fulcro app state on cleanup, and will follow any edges (a set of keywords) and remove any things pointed through those keywords as well. See normalized-state's remove-entity.

(defsc NewRoot [this props]
  {:use-hooks? true}
  (let [generated-id (hooks/use-generated-id)
        f (use-fulcro-mount this {:child-class SomeChild
                                  :initial-state-params {:id generated-id})]
    ;; will garbage-collect the floating root child on unmount
    (use-gc this [:child/id generated-id] #{})
    (f props)))

use-generated-id clj/s

(use-generated-id)

Returns a constant ident with a generated ID component.

use-imperative-handle clj/s

(use-imperative-handle ref f)

A simple wrapper around React/useImperativeHandle.

React docs: https://reactjs.org/docs/hooks-reference.html#useimperativehandle

use-layout-effect clj/s

(use-layout-effect f)

(use-layout-effect f args)

A simple wrapper around React/useLayoutEffect.

React docs: https://reactjs.org/docs/hooks-reference.html#uselayouteffect

use-lifecycle clj/s macro

(use-lifecycle setup)

(use-lifecycle setup teardown)

A macro shorthand that evaulates to low-level js at compile time for (use-effect (fn [] (when setup (setup)) (when teardown teardown)) [])

use-memo clj/s

(use-memo cb)

(use-memo cb args)

A simple wrapper around React/useMemo. Converts args to js array before send.

React docs: https://reactjs.org/docs/hooks-reference.html#usememo

use-reducer clj/s

(use-reducer reducer initial-arg)

(use-reducer reducer initial-arg init)

A simple wrapper around React/useReducer. Returns a cljs vector for easy destructuring

React docs: https://reactjs.org/docs/hooks-reference.html#usecontext

use-ref clj/s

(use-ref)

(use-ref value)

A simple wrapper around React/useRef.

React docs: https://reactjs.org/docs/hooks-reference.html#useref

use-state clj/s

(use-state initial-value)

A simple wrapper around React/useState. Returns a cljs vector for easy destructuring.

React docs: https://reactjs.org/docs/hooks-reference.html#usestate

useEffect clj/s

(useEffect f)

(useEffect f js-deps)

A CLJC wrapper around js/React.useEffect that does NO conversion of dependencies. You probably want the macro use-effect instead.

React docs: https://reactjs.org/docs/hooks-reference.html#useeffect

useState clj/s

(useState initial-value)

A simple CLJC wrapper around React/useState. Returns a JS vector for speed. You probably want use-state, which is more convenient.

React docs: https://reactjs.org/docs/hooks-reference.html#usestate