Document that componentDidUpdate happens before paint

[landabaso]

From the docs:

componentDidUpdate() is invoked immediately after updating occurs. This method is not called for the initial render. Use this as an opportunity to operate on the DOM when the component has been updated.

Please, correct me if I'm wrong. When the the last component in a large sequence of nested component changes, then all cDU from last child to parent are called in sequence. After the last cDU is called, then flushBatchedUpdates is run which, in turn, calls runBatchedUpdates.

Read this comment from @sebmarkbage for more context:
#2659 (comment)

If this is correct, the docs should say something like: Use this as an opportunity to enqueue DOM operations in the next execution thread.

EDIT: I guess this issue is also related to new hooks proposal: componentWasMounted and componentWasUpdated ( #7678).
In the meanwhile, it would be great if the docs specified that componentDid/Mount/Update should use requestAnimationFrame/setTimeout to access the rendered DOM.

[jftesser]

I was confused by this documentation too. Adding a description of a reliable way to access the rendered DOM would be much appreciated.

[bvaughn]

The comment referenced (#2659) is really old. I wouldn't read much into it since React has changed a lot in the last 3 years.

In the meanwhile, it would be great if the docs specified that componentDid/Mount/Update should use requestAnimationFrame/setTimeout to access the rendered DOM.

I'm not sure I understand why this is necessary. Could you elaborate? did-mount and did-update are called after changes have been flushed to the DOM, so you can synchronously access refs or their backing DOM elements in those methods.

The documentation and source code for reactjs.org now lives in a different repository: reactjs/reactjs.org. (For more info on why we made this move, see issue #11075.) Let's re-open a new issue in that repository to continue the discussion if you're still interested!

[jankalfus]

@bvaughn The methods get called after the changes have been flushed to the DOM, but that's irrelevant. The problem is that they get called before the first browser painting happens, not after.

To give you an example, when you have an element with overflow set to scroll, the clientWidth/clientHeight property will report incorrect values in componentDidMount. However, correct values get reported if you wrap your code retrieving the values in setTimeout or requestAnimationFrame.

[bvaughn]

when you have an element with overflow set to scroll, the clientWidth/clientHeight property will report incorrect values in componentDidMount. However, correct values get reported if you wrap your code retrieving the values in setTimeout or requestAnimationFrame

Can you point me at a repro that shows this behavior, by chance?

The methods get called after the changes have been flushed to the DOM, but that's irrelevant.

As for the relevance 😄 I was just pointing out that requestAnimationFrame / setTimeout are not required to access DOM elements from cDM/cDU because those elements already exist and are accessible. Updating the docs to say that you should add async delay before accessible DOM elements might give the (incorrect) impression that those elements haven't been created and appended yet when the lifecycle hooks are called.

[jankalfus]

Sorry, looks like a was hasty. setTimeout/requestAnimationFrame did not solve the problem for me.

In my particular case, I've nailed it down to padding causing the problem. For some reason, the 'clientWidth' that's received in cDM is smaller by the total padding amount of the surrounding component (maybe it gets painted first without the padding?). But it is accurate if obtained a bit later.

I'll attach a fiddle if I can reproduce this.

[bvaughn]

is this being caused by a box-sizing style by chance? (Something that may be inherited from a parent style that may be changed?)

Okay. Thanks.

[jankalfus]

Nevermind, my issue was caused by something else. Sorry.

[bvaughn]

It happens. 😄

[jgosmann]

I did encounter exactly the issue that clientHeight in componentDidMount was reported incorrectly. Moving the code to a callback for requestAnimationFrame solved the problem.

[bvaughn]

I did encounter exactly the issue that clientHeight in componentDidMount was reported incorrectly.

Huh...that does not sound expected. Assuming stylesheets have already loaded (since they might affect layout) then reading clientHeight from within componentDidMount should force the browser to do a sync layout (not great but sometimes necessary) and return a valid clientHeight.

[jgosmann]

We also use Aphrodite and I just stumbled across this:

Aphrodite uses asap to schedule buffer flushing. If you measure DOM elements' dimensions in componentDidMount or componentDidUpdate, you can use setTimeout or flushToStyleTag to ensure all styles are injected.

While I haven't verified it yet, this might be the reason for the behavior I observed.

[bvaughn]

Sounds like the likely cause to me ^