Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
118 commits
Select commit Hold shift + click to select a range
444896e
Initial draft for 16.3 release blog
bvaughn Feb 5, 2018
141de66
Wording changes in response to PR feedback
bvaughn Feb 5, 2018
ce57928
Added entry for createRef API
bvaughn Feb 6, 2018
da29d89
Added note about string ref API to strict mode section
bvaughn Feb 6, 2018
a55480b
Small wording nit
bvaughn Feb 6, 2018
935d2a1
Minor edits in response to PR feedback
bvaughn Feb 6, 2018
ab62e88
Formatted example
bvaughn Feb 7, 2018
08d444e
Wordsmithing in response to PR feedback
bvaughn Feb 12, 2018
5a1d653
Incorporated Sophie's PR feedback
bvaughn Feb 13, 2018
8494428
Added example of before/after context API
bvaughn Feb 13, 2018
c08533a
Removed context-before example
bvaughn Feb 13, 2018
33ff167
Wordsmith nit
bvaughn Feb 13, 2018
c09a284
Added React.createRef doc
trueadm Feb 22, 2018
ee78358
address feedback
trueadm Feb 22, 2018
b049931
revised content as per PR feedback
trueadm Mar 4, 2018
9bc1932
updated line numbers
trueadm Mar 4, 2018
6627687
Describe what a ref is at the top of the doc
Mar 4, 2018
0e7243f
Merge intro paragraphs
Mar 4, 2018
c07a6b0
Merge pull request #1 from alexkrolick/create-ref-patch
trueadm Mar 4, 2018
7b02740
Create "Accessing refs" section above specific examples
Mar 4, 2018
d7b34d4
Merge pull request #2 from alexkrolick/create-ref-patch-2
trueadm Mar 4, 2018
8075ce2
Make the callback example more similar to the new API
Mar 4, 2018
96fe82c
Declare setRef method outside render
alexkrolick Mar 6, 2018
96b10a7
Grammar
alexkrolick Mar 6, 2018
962ef9a
Highlight deprecation notice
alexkrolick Mar 6, 2018
4b939d2
~~All things considered~~
alexkrolick Mar 6, 2018
04c7f16
Wording
alexkrolick Mar 6, 2018
b1adba0
Recommend old API when applicable
alexkrolick Mar 6, 2018
9b869fa
Update leading sentence
alexkrolick Mar 6, 2018
566406e
Add docs for new Context API (R16.3)
alexkrolick Mar 6, 2018
a89e6b8
Added link to context API docs
bvaughn Mar 6, 2018
5e0901d
Merge pull request #3 from alexkrolick/create-ref-patch-3
trueadm Mar 6, 2018
3f304b9
Merge pull request #4 from alexkrolick/create-ref-patch4
trueadm Mar 6, 2018
f6e5d65
Fixed off-by-one line highlights.
bvaughn Mar 7, 2018
6e35810
Merge branch 'master' into 16.3-release-blog-post
bvaughn Mar 7, 2018
6a1ba97
Moved 16.3 release date arbitrarily forward
bvaughn Mar 7, 2018
1de2e33
Fixed links
bvaughn Mar 7, 2018
c7a61e6
Imported StrictMode docs (and examples) from PR #596
bvaughn Mar 7, 2018
fecb153
Merge pull request #1 from trueadm/create-ref
bvaughn Mar 7, 2018
866ef01
Prettier
bvaughn Mar 7, 2018
12d7c16
Updated createRef 'value' attributes to 'current'
bvaughn Mar 14, 2018
e5bf594
Unnest callback ref example code
alexkrolick Mar 15, 2018
2f97f48
Fixed docs
bvaughn Mar 15, 2018
a357b64
Added React.forwardRef to 16.3 release blog post
bvaughn Mar 15, 2018
a937c46
Typo fixes
bvaughn Mar 15, 2018
201fcad
Added React.forwardRef to API and docs
bvaughn Mar 16, 2018
2b1de01
Rebuild Netlify
bvaughn Mar 16, 2018
22d0ec1
Updated forwardRef example to use named function
bvaughn Mar 16, 2018
fe033f6
Added StrictMode to docs sidenav
bvaughn Mar 16, 2018
f14f147
Renamed ref in example
bvaughn Mar 18, 2018
5d5a5d2
StrictMode title => Strict Mode
bvaughn Mar 19, 2018
2ead10e
Update nav
gaearon Mar 19, 2018
29d6592
Update React.Component reference to show deprecations and new lifecycles
bvaughn Mar 20, 2018
0780f72
Reorganize examples & legacy docs
alexkrolick Mar 21, 2018
a5022da
Add in-page TOC
alexkrolick Mar 21, 2018
fe3d0a4
Typo
alexkrolick Mar 21, 2018
808e5bd
Rephrase and reorganize
alexkrolick Mar 21, 2018
de22379
Syntax tweaks
alexkrolick Mar 21, 2018
291b2fd
Wording tweaks
alexkrolick Mar 21, 2018
6aa1995
Add solution to motivation problem
alexkrolick Mar 21, 2018
7c6688c
Highlight createContext()
alexkrolick Mar 21, 2018
b49f99b
Highlight whole createContext() call
alexkrolick Mar 21, 2018
dbce488
Merge pull request #3 from alexkrolick/new-context-api
bvaughn Mar 22, 2018
2f9b77a
16.4 -> 16.x
bvaughn Mar 22, 2018
e9ae68f
remove confusing {}
alexkrolick Mar 23, 2018
53d604f
~deprecated~ legacy
alexkrolick Mar 23, 2018
fec6d6c
Add mutliple contexts example
alexkrolick Mar 23, 2018
7b5764f
Add ref forwarding, lifecycle examples
alexkrolick Mar 23, 2018
0d32f18
Kill highlight
alexkrolick Mar 23, 2018
7db107b
+ "default value" comment
alexkrolick Mar 23, 2018
da091e6
Add note about how changes are determined
alexkrolick Mar 23, 2018
6eb29a1
Combine basic examples
alexkrolick Mar 23, 2018
9f54997
Update highlights
alexkrolick Mar 23, 2018
4e1282e
Add to "when to use context"
alexkrolick Mar 23, 2018
f588bd6
Update "legacy" wording
alexkrolick Mar 23, 2018
ccc1f26
Replace "deprecated" with "legacy" for now
alexkrolick Mar 23, 2018
3af89c9
Merge pull request #4 from alexkrolick/context-tweaks
bvaughn Mar 23, 2018
01c2691
Replaced cWRP in forwardRef example with cDU
bvaughn Mar 23, 2018
f5d5139
Formatted a Note
bvaughn Mar 23, 2018
5864093
Updated context-in-lifecycles example
bvaughn Mar 23, 2018
d66d3a2
Updated TODO for later
bvaughn Mar 23, 2018
ef23c49
Updated multi-context example to show more indirection
bvaughn Mar 23, 2018
b25276a
Updated forward-refs example to use class component
bvaughn Mar 23, 2018
c41bb29
Added DevTools name consideration to forwardRef examples
bvaughn Mar 23, 2018
1ead060
17 -> future version
alexkrolick Mar 23, 2018
d58c892
+ "same algo"
alexkrolick Mar 23, 2018
e689824
Add notes about composing multiple contexts
alexkrolick Mar 23, 2018
509b126
Explain context in lifecycle a bit more
alexkrolick Mar 23, 2018
fe84e09
Explain why you need forwardRef
alexkrolick Mar 23, 2018
9e4442a
typo
alexkrolick Mar 23, 2018
3c44882
Use function keyword
alexkrolick Mar 23, 2018
f9225e2
Remove propTypes
alexkrolick Mar 23, 2018
fb8e9e8
kill class props
alexkrolick Mar 23, 2018
6919801
Use functional component
alexkrolick Mar 23, 2018
c9d50e3
Remove lib link
alexkrolick Mar 23, 2018
7ac0712
Updated 16.3 blog post to account for getSnapshotBeforeUpdate lifecycle
bvaughn Mar 23, 2018
920b4f4
Replace divs with some fake components
alexkrolick Mar 23, 2018
349446d
Add caveats section
alexkrolick Mar 23, 2018
b0e8604
Prettier
alexkrolick Mar 23, 2018
8437e37
Fix syntax
alexkrolick Mar 23, 2018
587ad93
Merge pull request #5 from alexkrolick/16.3-release-blog-post
bvaughn Mar 23, 2018
f11a149
Added DevTools naming consideration to React.forwardRef reference doc…
bvaughn Mar 24, 2018
bd06bbc
Added context HOC example to reference
bvaughn Mar 24, 2018
b7b97c0
Merge branch 'master' into 16.3-release-blog-post
bvaughn Mar 27, 2018
6d77836
Linked to async blog post
bvaughn Mar 27, 2018
e5cf31a
Renamed blog post
bvaughn Mar 27, 2018
a29098e
Merge branch 'master' into 16.3-release-blog-post
bvaughn Mar 28, 2018
57eb7cc
Tweaked message about what goes into state
bvaughn Mar 29, 2018
28b2b76
Tweaked state-and-lifecycle wording more
bvaughn Mar 29, 2018
691cd45
Added inline child function caveat to Context docs
bvaughn Mar 29, 2018
032576c
Prettier
bvaughn Mar 29, 2018
797a792
Revert "Prettier"
bvaughn Mar 29, 2018
3a36a40
Revert "Added inline child function caveat to Context docs"
bvaughn Mar 29, 2018
e5ca13e
Cross-link to async update post
bvaughn Mar 29, 2018
992a756
Missing 'we'
bvaughn Mar 29, 2018
5a587d1
Tweaked link to Context API
bvaughn Mar 29, 2018
ac1d767
Fixed link
bvaughn Mar 29, 2018
aa9810f
Fixed some links and improved a recommendation
bvaughn Mar 29, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion content/docs/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ Accepts a `value` prop to be passed to Consumers that are descendants of this Pr

A React component that subscribes to context changes.

Requires a [function as a child](/docs/render-props.html#using-props-other-than-render). The function receives the current context value and returns a React node. All consumers are re-rendered whenever the Provider value changes. Changes are determined by comparing the new and old values using the same algorithm as [`Object.is`](developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is#Description). (This can cause some issues when passing objects as `value`: see [Caveats](#caveats).)
Requires a [function as a child](/docs/render-props.html#using-props-other-than-render). The function receives the current context value and returns a React node. The function should be created inline, as shown in the example above, rather than being bound to the instance or otherwise cached. (Refer to the see [Caveats](#consumer-inline-function-as-a-child) section below for more.)

All consumers are re-rendered whenever the Provider value changes. Changes are determined by comparing the new and old values using the same algorithm as [`Object.is`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is#Description). (This can cause some issues when passing objects as `value`: see [Caveats](#objectis).)

> Note
>
Expand Down Expand Up @@ -134,6 +136,16 @@ One issue with the render prop API is that refs don't automatically get passed t

## Caveats
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before Caveats, I think we should also add a section that explains how to create a higher order component for consuming context. This is a common sentiment and I think we should proactively address it: https://twitter.com/DankoKozar/status/977469702204162048?s=20

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context comes before the Higher-Order Components reference page, but I'll cross link.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, cyclical dependencies are pretty much unavoidable in the "Advanced" section


### `Consumer` Inline Function as a Child

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bye bye

As an optimization to avoid doing unnecessary work, React currently stops rendering when it sees children that are equal to the most recently rendered children. This applies to the [function as a child](/docs/render-props.html#using-props-other-than-render) pattern used by `Consumer` as well which can cause unexpected behavior in some situations:
`embed:context/consumer-cached-function-as-a-child.js`

To avoid this scenario, we recommend declaring the child function inline:
`embed:context/consumer-inline-function-as-a-child.js`

### `Object.is`

Because context uses reference identity to determine when to re-render, there are some gotchas that could trigger unintentional renders in consumers when a provider's parent re-renders. For example, the code below will re-render all consumers every time the Provider re-renders because a new object is always created for `value`:

`embed:context/reference-caveats-problem.js`
Expand Down
4 changes: 1 addition & 3 deletions content/docs/state-and-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,9 +249,7 @@ The `componentDidMount()` hook runs after the component output has been rendered

Note how we save the timer ID right on `this`.

While `this.props` is set up by React itself and `this.state` has a special meaning, you are free to add additional fields to the class manually if you need to store something that is not used for the visual output.

State is generally used to store values that are referenced by `render()` (for visual output) or by `getDerivedStateFromProps()` (to compare next and previous props values).
While `this.props` is set up by React itself and `this.state` has a special meaning, you are free to add additional fields to the class manually if you need to store something that doesn’t participate in the data flow (like a timer ID).

We will tear down the timer in the `componentWillUnmount()` lifecycle hook:

Expand Down
15 changes: 15 additions & 0 deletions examples/context/consumer-cached-function-as-a-child.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
class Example extends React.Component {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bye

// This method will be called when the context value changes,
// But not when the props value changes!
renderValue = value => {
return (
<div>
Context value:{value}. Props value:{this.props.counter}
</div>
);
};

render() {
return <Ctx.Consumer>{this.renderValue}</Ctx.Consumer>;
}
}
15 changes: 15 additions & 0 deletions examples/context/consumer-inline-function-as-a-child.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
class Example extends React.Component {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bye

render() {
// The inline function will be called when the context value changes,
// And when the props value changes!
return (
<Ctx.Consumer>
{value => (
<div>
Context value:{value}. Props value:{this.props.counter}
</div>
)}
</Ctx.Consumer>
);
}
}