reagent/doc/FAQ/ComponentNotRerendering.md

50 lines
2.7 KiB
Markdown
Raw Normal View History

2018-02-27 01:23:16 +00:00
### Question
2018-02-27 04:57:32 +00:00
My component is not re-rendering, what's wrong?
2018-02-27 01:23:16 +00:00
### Answer
2018-02-27 04:57:32 +00:00
Ask yourself this question: why do you think the Component should have re-rendered? There's two possible answers:
2018-02-27 04:51:50 +00:00
- a ratom (used by the Component) changed
- the props for (arguments to) the Component changed
2018-02-27 01:23:16 +00:00
2018-02-27 04:57:32 +00:00
We'll deal with these two cases seperately.
2018-02-27 04:51:50 +00:00
### A Ratom Changed
If a ratom changes but your Component doesn't update, then the gotchas to look out for are:
1. Make sure you are using a `reagent.core/atom` (i.e. a Reagent ratom) instead of a normal `clojure.core/atom`. Carefully check the `require` at the top of the `ns`. Components are only reactive with respect to Reagent ratoms. They don't react to changes in a Clojure atom.
2018-02-27 05:15:52 +00:00
2. Make sure you actually `deref` your ratom (e.g, @app-state) during the render function of your component. It is a common mistake for people to forget the leading `@`. Note that derefs that happen outside of the render function (such as during event handlers) do not make your component reactive to that ratom.
3a. Make sure your ratom will survive a rerender. Either declare it as a global var, or use a form-2 or form-3 component. [Read this](https://github.com/reagent-project/reagent-cookbook/tree/master/basics/component-level-state) if you want to understand why.
3b. If you put your ratom in a form-2 or form-3 component, be sure you are calling that function using \[square brackets\], not \(parenthesis\).
2018-02-27 04:51:50 +00:00
4. Make sure to `deref` your ratom outside of a seq or wrap that seq in a `doall`. See this [related issue](https://github.com/reagent-project/reagent/issues/18).
### Props Change
If the props to a Component change, but it doesn't appear to re-render, then the cause will be this rookie mistake: you forgot to repeat the parameters in the inner, anonymous render function.
2018-02-27 05:02:41 +00:00
```clj
2018-02-27 04:51:50 +00:00
(defn outer
[a b c] ;; <--- parameters
;; ....
(fn [a b c] ;; <--- forgetting to repeat parameters here is the mistake
[:div
(str a b c)]))
```
If you forget, the component renderer will stubbornly only ever render the
original parameter values, not the updated ones, which can be baffling for
a beginner.
Remember, `outer` is called once per component instance. The parameters to `outer`
will hold the initial parameter values. The inner renderer on the other hand,
will be called by Reagent many times and, each time, potentially with alternative
parameter values, but unless you repeat the parameters on the renderer it will
close over those initial values in `outer`. As a result, the component renderer
will stubbornly only ever render the original parameter values, not the updated ones.
2018-02-27 01:23:16 +00:00
***
Up: [FAQ Index](../README.md)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;