docs(react): distinguish observer from inline Observer - #4704
Open
MuslumYilmaz wants to merge 1 commit into
Open
docs(react): distinguish observer from inline Observer#4704MuslumYilmaz wants to merge 1 commit into
MuslumYilmaz wants to merge 1 commit into
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation gap
The React integration guide documents both the
observerHOC and the<Observer>render-prop component, but the guidance is separated across thepage. A reader can miss that they establish tracking at different rendering
boundaries.
Proposed documentation change
Add a compact “Which boundary should be observed?” note near the callback
component example:
observer(Component)when the component owns the render that reads theobservable.
<Observer>{() => ...}</Observer>when the observable is read inside acallback rendered by a third-party or otherwise non-observer component.
observerwith another HOC, keepobserverinnermost so itcan track reads performed by the wrapped component.
This would connect the existing callback example with the existing HOC
wrap-order tip. It requires no API or runtime changes.
For readers who need a general refresher on render-prop and HOC composition,
this comparison can serve as an optional exercise:
https://frontendatlas.com/react/trivia/react-render-props-vs-hocs
Disclosure: I maintain FrontendAtlas. The reference is optional and can be
removed if external learning links are outside the documentation policy.