Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog for unreleased 16.0 changes #10730

Merged
merged 13 commits into from
Sep 22, 2017
Merged

Update changelog for unreleased 16.0 changes #10730

Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
dcbbeae
First shot at updating changelog for 16.0
flarnie Sep 18, 2017
b623165
Fix typos and formatting errors in changelog
flarnie Sep 18, 2017
68ff634
Add requestAnimationFrame and remove "New helpful warnings"
flarnie Sep 20, 2017
8df6b69
Improve wording
flarnie Sep 20, 2017
48e8f2e
Improve wording and fix missing links
flarnie Sep 21, 2017
42f2b0c
Add backticks to file names & code; wording tweak
flarnie Sep 21, 2017
bfb2e58
Break "Major Changes" into "New Feature" and "Breaking Changes"
flarnie Sep 21, 2017
a63da18
Add server side render changes to 16.0 changelog
flarnie Sep 21, 2017
9e900f1
Change gist link from mine to gaearons
flarnie Sep 21, 2017
3068a6f
Add note about returning fragments
flarnie Sep 21, 2017
be5c8e6
fix misc nits
flarnie Sep 21, 2017
a26aef4
Misc. formatting/wording fixes to changelog
flarnie Sep 22, 2017
8ee0ec0
fix broken link
flarnie Sep 22, 2017
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
49 changes: 49 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
## [Unreleased]
<details>
<summary>
Changes that have landed in master but are not yet released.
Click to see more.
</summary>

### JS Environment Requirements
Copy link
Contributor

Choose a reason for hiding this comment

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

What about requestAnimationFrame?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good_catch_corgi

will fix!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe worth changing to "New JS Environment Requirements" to better signal it is a change.


* **React 16 depends on the collection types [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) and [Set](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set).** If you support older browsers and devices which may not yet provide these natively (eg <IE11), consider including a global polyfill in your bundled application, such as [core-js](https://github.com/zloirock/core-js) or [babel-polyfill](https://babeljs.io/docs/usage/polyfill/).

### Major Changes

* **Improved error handling with introduction of "error boundaries".** [Error boundaries](https://facebook.github.io/react/blog/2017/07/26/error-handling-in-react-16.html) are React components that catch JavaScript errors anywhere in their child component tree, log those errors, and display a fallback UI instead of the component tree that crashed.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would prefer if we separated error boundaries and portals into a separate "New Features" section. We could also add that components can now return arrays and strings into it, and that custom DOM attributes are now passed through (since it's technically one of top requested features).

Then the second section would be "Breaking Changes". It's fine to repeat the "unknown attributes" thing there since in addition to being a new feature, it's also a breaking change. But other new features (portals, arrays, error boundaries) are not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sweet! I was struggling to find the groupings within 'major changes' and I really like those two. Will fix.

- **There are several changes to the behavior of scheduling and lifecycle methods:**
* `ReactDOM.render()` and `ReactDOM.unstable_renderIntoContainer()` now return `null` if called from inside a lifecycle method.
* To work around this, you can either use [the new portal API](https://github.com/facebook/react/issues/10309#issuecomment-318433235) or [refs](https://github.com/facebook/react/issues/10309#issuecomment-318434635).
* `setState`:
* Calling `setState` with null no longer triggers an update. This allows you to decide in an updater function if you want to re-render.
* Calling `setState` directly in render always causes an update. This was not previously the case. Regardless, you should not be calling setState from render.
* `setState` callback (second argument) now fires immediately after `componentDidMount` / `componentDidUpdate` instead of after all components have rendered.
* When replacing `<A />` with `<B />`, `B.componentWillMount` now always happens before `A.componentWillUnmount`. Previously, `A.componentWillUnmount` could fire first in some cases.
* Previously, changing the ref to a component would always detach the ref before that component's render is called. Now, we change the ref later, when applying the changes to the DOM.
* It is not safe to re-render into a container that was modified by something other than React. This worked previously in some cases but was never supported. We now emit a warning in this case. Instead you should clean up your component trees using `ReactDOM.unmountComponentAtNode`. [See this example.](https://github.com/facebook/react/issues/10294#issuecomment-318820987)
* `componentDidUpdate` lifecycle no longer receives `prevContext` param. (See #8631)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This will not turn into a link in a Markdown file. GH only linkifies in comments and issues.

* Shallow renderer no longer calls `componentDidUpdate()` because DOM refs are not available. This also makes it consistent with `componentDidMount()` (which does not get called in previous versions either).
* Shallow renderer does not implement `unstable_batchedUpdates()` anymore.
- **The names and paths to the single-file browser builds have changed to emphasize the difference between development and production builds.** For example:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: not clear why this one is bold but others aren't

- react/dist/react.js → react/umd/react.development.js
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should put filenames in backticks for nicer formatting.

- react/dist/react.min.js → react/umd/react.production.min.js
- react-dom/dist/react-dom.js → react-dom/umd/react-dom.development.js
- react-dom/dist/react-dom.min.js → react-dom/umd/react-dom.production.min.js
* ReactDOM.createPortal() is official and stable
([@gaearon](https://github.com/gaearon) in
[10675](https://github.com/facebook/react/pull/10675))
* Allow [passing some "unknown" attributes through to DOM components](https://facebook.github.io/react/blog/2017/09/08/dom-attributes-in-react-16.html) (@nhunzaker in https://github.com/facebook/react/pull/10385 , https://github.com/facebook/react/pull/10564 , https://github.com/facebook/react/pull/10495 and others)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This also looks pretty bad in Markdown file. These need to be turned into real links.


Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should add a separate point about error boundaries here as it is a breaking change. Specifically:

  • Errors in the render and lifecycle methods now unmount the component tree by default. To prevent this, add error boundaries to the appropriate places in the UI. (And make it a link)

### Removed deprecations
Copy link
Collaborator

Choose a reason for hiding this comment

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

Capitalisation nit to match other sections: Removed Deprecations


- **There is no react-with-addons.js build anymore.** All compatible addons are published separately on npm, and have single-file browser versions if you need them.
- **The deprecations introduced in 15.x have been removed from the core package.** React.createClass is now available as create-react-class, React.PropTypes as prop-types, React.DOM as react-dom-factories, react-addons-test-utils as react-dom/test-utils, and shallow renderer as react-test-renderer/shallow. See [15.5.0](https://facebook.github.io/react/blog/2017/04/07/react-v15.5.0.html) and [15.6.0](https://facebook.github.io/react/blog/2017/06/13/react-v15.6.0.html) blog posts for instructions on migrating code and automated codemods.

### New helpful warnings

Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's remove this section. There is quite a bit of new (or improved) warnings in 16. These are just the ones added between RCs and IMO having them here is more confusing than skipping the whole section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks - will remove for now.

What if I got the diff in warnings between 15 and 16 and documented the changes? Could be a follow-up.

* Improve error message when ReactDOM loads without React (@aweary in https://github.com/facebook/react/pull/10449)
* Warn when nesting 15 subtree inside 16 (@sophiebits in https://github.com/facebook/react/pull/10434)

</details>

## 15.6.1 (June 14, 2017)

### React DOM
Expand Down