docs: Improve transition documentation

Resolves #17047

docs/pages/api/dialog.md

@@ -46,9 +46,9 @@ Dialogs are overlaid modal paper based components with a backdrop.
 | <span class="prop-name">PaperComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Paper</span> | The component used to render the body of the dialog. |
 | <span class="prop-name">PaperProps</span> | <span class="prop-type">object</span> | <span class="prop-default">{}</span> | Props applied to the [`Paper`](/api/paper/) element. |
 | <span class="prop-name">scroll</span> | <span class="prop-type">'body'<br>&#124;&nbsp;'paper'</span> | <span class="prop-default">'paper'</span> | Determine the container for scrolling the dialog. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Fade</span> | The component used for the transition. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Fade</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
 | <span class="prop-name">transitionDuration</span> | <span class="prop-type">number<br>&#124;&nbsp;{ enter?: number, exit?: number }</span> | <span class="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen }</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/expansion-panel.md

@@ -30,8 +30,8 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 | <span class="prop-name">disabled</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | If `true`, the panel will be displayed in a disabled state. |
 | <span class="prop-name">expanded</span> | <span class="prop-type">bool</span> | | If `true`, expands the panel, otherwise collapse it. Setting this prop enables control over the panel. |
 | <span class="prop-name">onChange</span> | <span class="prop-type">func</span> | | Callback fired when the expand/collapse state is changed.<br><br>**Signature:**<br>`function(event: object, expanded: boolean) => void`<br>*event:* The event source of the callback.<br>*expanded:* The `expanded` state of the panel. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Collapse</span> | The component used for the collapse effect. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Collapse</span> | The component used for the collapse effect. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/popover.md

@@ -45,9 +45,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 | <span class="prop-name required">open&nbsp;*</span> | <span class="prop-type">bool</span> | | If `true`, the popover is visible. |
 | <span class="prop-name">PaperProps</span> | <span class="prop-type">{ component?: element type }</span> | <span class="prop-default">{}</span> | Props applied to the [`Paper`](/api/paper/) element. |
 | <span class="prop-name">transformOrigin</span> | <span class="prop-type">{ horizontal: number<br>&#124;&nbsp;'left'<br>&#124;&nbsp;'center'<br>&#124;&nbsp;'right', vertical: number<br>&#124;&nbsp;'top'<br>&#124;&nbsp;'center'<br>&#124;&nbsp;'bottom' }</span> | <span class="prop-default">{ vertical: 'top', horizontal: 'left',}</span> | This is the point on the popover which will attach to the anchor's origin.<br>Options: vertical: [top, center, bottom, x(px)]; horizontal: [left, center, right, x(px)]. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Grow</span> | The component used for the transition. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Grow</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
 | <span class="prop-name">transitionDuration</span> | <span class="prop-type">number<br>&#124;&nbsp;{ enter?: number, exit?: number }<br>&#124;&nbsp;'auto'</span> | <span class="prop-default">'auto'</span> | Set to 'auto' to automatically calculate transition time based on height. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | <span class="prop-default">{}</span> | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | <span class="prop-default">{}</span> | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/snackbar.md

@@ -43,9 +43,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 | <span class="prop-name">onExiting</span> | <span class="prop-type">func</span> | | Callback fired when the transition is exiting. |
 | <span class="prop-name">open</span> | <span class="prop-type">bool</span> | | If `true`, `Snackbar` is open. |
 | <span class="prop-name">resumeHideDuration</span> | <span class="prop-type">number</span> | | The number of milliseconds to wait before dismissing after user interaction. If `autoHideDuration` prop isn't specified, it does nothing. If `autoHideDuration` prop is specified but `resumeHideDuration` isn't, we default to `autoHideDuration / 2` ms. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Grow</span> | The component used for the transition. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Grow</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
 | <span class="prop-name">transitionDuration</span> | <span class="prop-type">number<br>&#124;&nbsp;{ enter?: number, exit?: number }</span> | <span class="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen,}</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/speed-dial.md

@@ -35,9 +35,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 | <span class="prop-name">onOpen</span> | <span class="prop-type">func</span> | | Callback fired when the component requests to be open.<br><br>**Signature:**<br>`function(event: object, reason: string) => void`<br>*event:* The event source of the callback.<br>*reason:* Can be: `"toggle"`, `"focus"`, `"mouseEnter"`. |
 | <span class="prop-name required">open&nbsp;*</span> | <span class="prop-type">bool</span> | | If `true`, the SpeedDial is open. |
 | <span class="prop-name">openIcon</span> | <span class="prop-type">node</span> | | The icon to display in the SpeedDial Fab when the SpeedDial is open. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Zoom</span> | The component used for the transition. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Zoom</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
 | <span class="prop-name">transitionDuration</span> | <span class="prop-type">number<br>&#124;&nbsp;{ appear?: number, enter?: number, exit?: number }</span> | <span class="prop-default">{ enter: duration.enteringScreen, exit: duration.leavingScreen,}</span> | The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/step-content.md

@@ -26,9 +26,9 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 |:-----|:-----|:--------|:------------|
 | <span class="prop-name">children</span> | <span class="prop-type">node</span> | | Step content. |
 | <span class="prop-name">classes</span> | <span class="prop-type">object</span> | | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Collapse</span> | The component used for the transition. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Collapse</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
 | <span class="prop-name">transitionDuration</span> | <span class="prop-type">number<br>&#124;&nbsp;{ enter?: number, exit?: number }<br>&#124;&nbsp;'auto'</span> | <span class="prop-default">'auto'</span> | Adjust the duration of the content expand transition. Passed as a prop to the transition component.<br>Set to 'auto' to automatically calculate transition time based on height. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/tooltip.md

@@ -42,8 +42,8 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 | <span class="prop-name">placement</span> | <span class="prop-type">'bottom-end'<br>&#124;&nbsp;'bottom-start'<br>&#124;&nbsp;'bottom'<br>&#124;&nbsp;'left-end'<br>&#124;&nbsp;'left-start'<br>&#124;&nbsp;'left'<br>&#124;&nbsp;'right-end'<br>&#124;&nbsp;'right-start'<br>&#124;&nbsp;'right'<br>&#124;&nbsp;'top-end'<br>&#124;&nbsp;'top-start'<br>&#124;&nbsp;'top'</span> | <span class="prop-default">'bottom'</span> | Tooltip placement. |
 | <span class="prop-name">PopperProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Popper`](/api/popper/) element. |
 | <span class="prop-name required">title&nbsp;*</span> | <span class="prop-type">node</span> | | Tooltip title. Zero-length titles string are never displayed. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Grow</span> | The component used for the transition. |
-| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the `Transition` element. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Grow</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
+| <span class="prop-name">TransitionProps</span> | <span class="prop-type">object</span> | | Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element. |
 
 The `ref` is forwarded to the root element.
 

docs/pages/api/tree-item.md

@@ -32,7 +32,7 @@ You can learn more about the difference by [reading this guide](/guides/minimizi
 | <span class="prop-name">icon</span> | <span class="prop-type">node</span> | | The icon to display next to the tree node's label. |
 | <span class="prop-name">label</span> | <span class="prop-type">node</span> | | The tree node label. |
 | <span class="prop-name required">nodeId&nbsp;*</span> | <span class="prop-type">string</span> | | The id of the node. |
-| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Collapse</span> | The component used for the transition. |
+| <span class="prop-name">TransitionComponent</span> | <span class="prop-type">elementType</span> | <span class="prop-default">Collapse</span> | The component used for the transition. [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. |
 
 The `ref` is forwarded to the root element.
 

docs/src/pages/components/transitions/transitions.md

@@ -63,7 +63,7 @@ the `timeout` property to change the entry speed.
 Slide in from the edge of the screen.
 The `direction` property controls which edge of the screen the transition starts from.
 
-The Transition component's  `mountOnEnter` property prevents the child component from being mounted
+The Transition component's `mountOnEnter` property prevents the child component from being mounted
 until `in` is `true`. This prevents the relatively positioned component from scrolling into view
 from it's off-screen position. Similarly the `unmountOnExit` property removes the component
 from the DOM after it has been transition off screen.
@@ -77,3 +77,12 @@ Expand outwards from the center of the child element.
 This example also demonstrates how to delay the enter transition.
 
 {{"demo": "pages/components/transitions/SimpleZoom.js", "bg": true}}
+
+## TransitionComponent prop
+
+A few of the Material-UI components accept a `TransitionComponent` prop to customize the transition. You can use any of the above components or a home-made one.
+It should respect the following conditions:
+Accepts an `in` prop. This corresponds to the open / close state.
+Call the `onEnter` callback prop when the enter transition starts.
+Call the `onExited` callback prop when the exit transition is completed.
+These two callbacks allow to unmount the children when in a closed state and fully transitioned.

packages/material-ui-lab/src/SpeedDial/SpeedDial.d.ts

@@ -63,6 +63,7 @@ export interface SpeedDialProps
  openIcon?: React.ReactNode;
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent?: React.ComponentType<TransitionProps>;
  /**
@@ -71,7 +72,7 @@ export interface SpeedDialProps
  */
  transitionDuration?: TransitionProps['timeout'];
  /**
- * Props applied to the `Transition` element.
+ * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element.
  */
  TransitionProps?: TransitionProps;
 }

packages/material-ui-lab/src/SpeedDial/SpeedDial.js

@@ -438,6 +438,7 @@ SpeedDial.propTypes = {
  openIcon: PropTypes.node,
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent: PropTypes.elementType,
  /**
@@ -453,7 +454,7 @@ SpeedDial.propTypes = {
  }),
  ]),
  /**
- * Props applied to the `Transition` element.
+ * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element.
  */
  TransitionProps: PropTypes.object,
 };

packages/material-ui-lab/src/TreeItem/TreeItem.d.ts

@@ -30,6 +30,7 @@ export interface TreeItemProps
  nodeId: string;
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent?: React.ComponentType<TransitionProps>;
 }

packages/material-ui-lab/src/TreeItem/TreeItem.js

@@ -362,6 +362,7 @@ TreeItem.propTypes = {
  onKeyDown: PropTypes.func,
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent: PropTypes.elementType,
 };

packages/material-ui/src/Dialog/Dialog.js

@@ -371,6 +371,7 @@ Dialog.propTypes = {
  scroll: PropTypes.oneOf(['body', 'paper']),
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent: PropTypes.elementType,
  /**
@@ -382,7 +383,7 @@ Dialog.propTypes = {
  PropTypes.shape({ enter: PropTypes.number, exit: PropTypes.number }),
  ]),
  /**
- * Props applied to the `Transition` element.
+ * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element.
  */
  TransitionProps: PropTypes.object,
 };

packages/material-ui/src/ExpansionPanel/ExpansionPanel.js

@@ -202,10 +202,11 @@ ExpansionPanel.propTypes = {
  square: PropTypes.bool,
  /**
  * The component used for the collapse effect.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent: PropTypes.elementType,
  /**
- * Props applied to the `Transition` element.
+ * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element.
  */
  TransitionProps: PropTypes.object,
 };

packages/material-ui/src/Popover/Popover.js

@@ -593,6 +593,7 @@ Popover.propTypes = {
  }),
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent: PropTypes.elementType,
  /**
@@ -604,7 +605,7 @@ Popover.propTypes = {
  PropTypes.oneOf(['auto']),
  ]),
  /**
- * Props applied to the `Transition` element.
+ * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element.
  */
  TransitionProps: PropTypes.object,
 };

packages/material-ui/src/Snackbar/Snackbar.js

@@ -362,6 +362,7 @@ Snackbar.propTypes = {
  resumeHideDuration: PropTypes.number,
  /**
  * The component used for the transition.
+ * [Follow our guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
  */
  TransitionComponent: PropTypes.elementType,
  /**
@@ -373,7 +374,7 @@ Snackbar.propTypes = {
  PropTypes.shape({ enter: PropTypes.number, exit: PropTypes.number }),
  ]),
  /**
- * Props applied to the `Transition` element.
+ * Props applied to the [`Transition`](http://reactcommunity.org/react-transition-group/transition#Transition-props) element.
  */
  TransitionProps: PropTypes.object,
 };