From 19b7b2b6559a6ee5ebd6c6f379b7a32e5c26ae31 Mon Sep 17 00:00:00 2001 From: Flarnie Marchan Date: Tue, 4 Apr 2017 16:46:46 -0700 Subject: [PATCH] Update docs to deprecate ReactTransitionGroup - removes link to the docs about `ReactCSSTransitionGroup` and `ReactTransitionGroup` from the main navigation - updates 'prev' and 'next' pointers to skip this page - adds deprecation warning to the top of the page - remove references to these modules from the packages README - updates 'add-ons' main page to list this as a deprecated add-on --- docs/_data/nav_docs.yml | 4 ++-- docs/docs/addons-animation.md | 5 +++-- docs/docs/addons-create-fragment.md | 4 ++-- docs/docs/addons.md | 4 ++-- packages/react/README.md | 1 - 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/_data/nav_docs.yml b/docs/_data/nav_docs.yml index 1e66741d1fb2..8b494a7deea4 100644 --- a/docs/_data/nav_docs.yml +++ b/docs/_data/nav_docs.yml @@ -72,8 +72,8 @@ title: Performance Tools - id: test-utils title: Test Utilities - - id: animation - title: Animation + - id: shallow-renderer + title: Shallow Renderer - id: create-fragment title: Keyed Fragments - id: update diff --git a/docs/docs/addons-animation.md b/docs/docs/addons-animation.md index 0f684402730b..f7bb59fe575d 100644 --- a/docs/docs/addons-animation.md +++ b/docs/docs/addons-animation.md @@ -4,14 +4,15 @@ title: Animation Add-Ons permalink: docs/animation.html layout: docs category: Add-Ons -prev: addons.html -next: create-fragment.html redirect_from: - "docs/animation-ja-JP.html" - "docs/animation-ko-KR.html" - "docs/animation-zh-CN.html" --- +>Note: +> `ReactTransitionGroup` and `ReactCSSTransitionGroup` are both deprecated as of React v15.5.0. The recommendation is to use `TransitionGroup` and `CSSTransitionGroup` from ['react-transition-group'](https://github.com/reactjs/react-transition-group) instead. + The [`ReactTransitionGroup`](#low-level-api-reacttransitiongroup) add-on component is a low-level API for animation, and [`ReactCSSTransitionGroup`](#high-level-api-reactcsstransitiongroup) is an add-on component for easily implementing basic CSS animations and transitions. ## High-level API: ReactCSSTransitionGroup diff --git a/docs/docs/addons-create-fragment.md b/docs/docs/addons-create-fragment.md index 527525def5e5..b1b42b778478 100644 --- a/docs/docs/addons-create-fragment.md +++ b/docs/docs/addons-create-fragment.md @@ -4,8 +4,8 @@ title: Keyed Fragments permalink: docs/create-fragment.html layout: docs category: Add-Ons -prev: animation.html -next: perf.html +prev: shallow-renderer.html +next: update.html --- **Importing** diff --git a/docs/docs/addons.md b/docs/docs/addons.md index a927a4266ac4..3bdf6994e8eb 100644 --- a/docs/docs/addons.md +++ b/docs/docs/addons.md @@ -6,7 +6,6 @@ permalink: docs/addons.html The React add-ons are a collection of useful utility modules for building React apps. **These should be considered experimental** and tend to change more often than the core. -- [`TransitionGroup` and `CSSTransitionGroup`](animation.html), for dealing with animations and transitions that are usually not simple to implement, such as before a component's removal. - [`createFragment`](create-fragment.html), to create a set of externally-keyed children. The add-ons below are in the development (unminified) version of React only: @@ -24,7 +23,8 @@ The add-ons below are considered legacy and their use is discouraged. ### Deprecated Add-ons -[`LinkedStateMixin`](two-way-binding-helpers.html) has been deprecated. +- [`LinkedStateMixin`](two-way-binding-helpers.html) has been deprecated. +- [`TransitionGroup` and `CSSTransitionGroup`](animation.html) have been deprecated. ## Using React with Add-ons diff --git a/packages/react/README.md b/packages/react/README.md index 98754e724b6f..e6d4eabc05d7 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -17,7 +17,6 @@ var React = require('react'); // Addons are in separate packages: var createFragment = require('react-addons-create-fragment'); var immutabilityHelpers = require('react-addons-update'); -var CSSTransitionGroup = require('react-addons-css-transition-group'); ``` For a complete list of addons visit the [addons documentation page](https://facebook.github.io/react/docs/addons.html).