Funcool Rumext

https://funcool.github.io/rumext/latest/
Admin
Funcool Rumext is a ClojureScript library that provides React wrapper utilities, component macros,...
Tokens:1,010
Snippets:27
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### With Memo Macro

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Syntactic abstraction for useMemo.

```clojure
(with-memo deps & body)
```

--------------------------------

### Use Transition Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext version of useTransition returning an object implementing the IPending protocol.

```clojure
(use-transition)
```

--------------------------------

### With Effect Macro

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Syntactic abstraction for useEffect.

```clojure
(with-effect deps & body)
```

--------------------------------

### With Layout Effect Macro

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Syntactic abstraction for useLayoutEffect.

```clojure
(with-layout-effect deps & body)
```

--------------------------------

### use-transition

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

A rumext version of the useTransition hook function, returning a function object that implements the IPending protocol.

```APIDOC
## (use-transition)

### Description
A rumext version of the useTransition hook function. Returns a function object that implements the IPending protocol for check the state of the transition.
```

--------------------------------

### Use Memo Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext variant of the useMemo hook with inverted argument order.

```clojure
(use-memo f)
(use-memo deps f)
```

--------------------------------

### Use Function Alias

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Convenience alias for use-callback.

```clojure
(use-fn f)
(use-fn deps f)
```

--------------------------------

### with-effect

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

A convenience syntactic abstraction (macro) for useEffect.

```APIDOC
## (with-effect deps & body)

### Description
A convenience syntactic abstraction (macro) for useEffect.
```

--------------------------------

### spread-props

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

A macro helper for spreading two JS objects using React conventions for compile-time known prop key names.

```APIDOC
## (spread-props target other)

### Description
A helper for spreading two JS objects using react conventions for compile time known props keys names.
```

--------------------------------

### Use Callback Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext variant of the useCallback hook with inverted argument order.

```clojure
(use-callback f)
(use-callback deps f)
```

--------------------------------

### Use Previous Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Custom hook that returns a value from the previous render.

```clojure
(use-previous value)
```

--------------------------------

### Spread Props Macro

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Helper for spreading two JS objects using React conventions for compile-time known prop key names.

```clojure
(spread-props target other)
```

--------------------------------

### Use State Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext variant of useState that returns an object implementing Atom protocols.

```clojure
(use-state)
(use-state initial)
```

--------------------------------

### use-callback

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

A rumext variant of the useCallback hook function with the order of arguments inverted.

```APIDOC
## (use-callback f) or (use-callback deps f)

### Description
A rumext variant of the useCallback hook function with order of arguments inverted.
```

--------------------------------

### Check component props with memoization

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Utility function used with memo' to check specific keys in props for equality.

```clojure
(mf/defc my-component
  {::mf/wrap [#(mf/memo' % (mf/check-props ["prop1" "prop2"]))]}
  [props]

)
```

--------------------------------

### Use Var Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Custom hook using useRef that returns an object implementing Atom protocols without triggering re-renders.

```clojure
(use-var)
(use-var initial)
```

--------------------------------

### Use SSR Effect Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Experimental effect hook that runs immediately in non-browser contexts.

```clojure
(use-ssr-effect deps effect-fn)
```

--------------------------------

### use-state

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

A rumext variant of useState that returns an object implementing the Atom protocols.

```APIDOC
## (use-state) or (use-state initial)

### Description
A rumext variant of useState. Returns an object that implements the Atom protocols.
```

--------------------------------

### Use Ref Function Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Custom hook returning a stable callback pointer that calls an interned callback, updated on render.

```clojure
(use-ref-fn f)
```

--------------------------------

### Use Equal Memo Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Custom hook that preserves object identity using value equality. Optionally accepts a custom equality function.

```clojure
(use-equal-memo val)
(use-equal-memo eqfn val)
```

--------------------------------

### Use Update Ref Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Custom hook that updates the ref value when the input value changes.

```clojure
(use-update-ref value)
```

--------------------------------

### Use Debounce Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Custom hook that debounces value changes.

```clojure
(use-debounce ms value)
```

--------------------------------

### Use Effect Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext variant of the useEffect hook with inverted argument order.

```clojure
(use-effect f)
(use-effect deps f)
```

--------------------------------

### Use Layout Effect Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext variant of the useLayoutEffect hook with inverted argument order.

```clojure
(use-layout-effect f)
(use-layout-effect deps f)
```

--------------------------------

### Use Insertion Effect Hook

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Rumext variant of the useInsertionEffect hook with inverted argument order.

```clojure
(use-insertion-effect f)
(use-insertion-effect deps f)
```

--------------------------------

### Throttle Higher-Order Component

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Higher-order component that throttles the rendering of the provided component.

```clojure
(throttle component ms)
```

--------------------------------

### Unmount Component

Source: https://funcool.github.io/rumext/latest/rumext.v2.html

Removes a component from the DOM tree.

```clojure
(unmount! root)
```
Tokens:
Raw