Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
onnovisser committed Aug 31, 2017
1 parent 8795cb3 commit 60a48b6
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Wrap the component you intend to animate.
</ConnectedTransition>
```

When the `ConnectedTransition` unmounts and one with the same name mounts at the same time, the child of each will have its `getTransitionData()` called, followed by `componentWillLeave()` and `componentWillEnter()` respectively.
When a `ConnectedTransition` unmounts and one with the same name mounts at the same time, the child of each will have its `getTransitionData()` called, followed by `componentWillLeave()` and `componentWillEnter()` respectively.


```jsx
Expand Down Expand Up @@ -137,6 +137,12 @@ class SomeComponent extends Component {

By default, the `ConnectedTransition` component waits for its child to unmount before sending its data to the mounting component with the same name. When using `react-transition-group`, a component will stay mounted for the duration of the transition before unmounting. To tell the `ConnectedTransition` to expect a transtion, pass `exit={true}` when exiting.

* #### passive

`PropTypes.bool`

A passive `ConnectedTransition` won't have its `getTransitionData()` hook called. `componentWillEnter()` or `componentWillLeave()` will be called when this component enters or leaves at the same time as another `ConnectedTransition` with the same name.

* * *

## Reference
Expand Down

0 comments on commit 60a48b6

Please sign in to comment.