Skip to content

Commit 936dd63

Browse files
committed
Update README files.
1 parent d3f30a1 commit 936dd63

File tree

4 files changed

+31
-7
lines changed

4 files changed

+31
-7
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
### v2.0.0 (11 September 2016)
2+
3+
* [ENHANCEMENT] Add support for IE<=11 (thanks @le0nik) (#22, #23)
4+
* [ENHANCEMENT] Add ability to provide custom `height` className (useful for `css-modules`) (thanks @le0nik) (#20, #21)
5+
* [BUGFIX] Fix multiple remounts of children (thanks @le0nik) (#24)
6+
* [BUGFIX] Allow the child, that is leaving, to be `null` (thanks @le0nik)
7+
18
### v1.3.0 (9 July 2016)
29

310
* [ENHANCEMENT] When removing an element just added to an empty container transitions are reset to avoid getting stuck.

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ that the transition duration must be specified in JavaScript as well as CSS.
2828
Install via `npm`:
2929

3030
```
31-
npm install react-css-transition-replace
31+
npm install --save react-css-transition-replace
3232
```
3333

3434

@@ -43,7 +43,9 @@ and the new component animated in. During this process:
4343
- The entering component is positioned on top of the leaving component with `absolute` positioning.
4444
- The height of the container is set to that of the leaving component, and then immediately to that of the
4545
entering component, and the `{animation-name}-height` class is applied to it, if type of `transitionName` is
46-
`String`. If type of `transitionName` is `Object`, `transitionName.height` class will be used without modifications.
46+
`String`. If type of `transitionName` is `Object`, `transitionName.height` class will be used without modifications,
47+
if present.
48+
- The leaving component will be passed `isLeaving` prop while transitioning out.
4749

4850
This provides many possibilities for animating the replacement as illustrated in the examples below.
4951

@@ -191,10 +193,10 @@ pages one might use:
191193
to avoid collapsing margins overall.
192194
- Turn this feature off by setting the `overflowHidden={false}` prop when hidden overflow is not needed,
193195
for example when transitions are in place and content is of the same height.
194-
3. If the `.*-height` class is not specified the change in container height will not be animated but instead
195-
jump to the height of the entering component instantaneously. It can, therefore, be omitted if all content
196-
is known to be of the same height without any adverse side-effects, and absolute positioning related height
197-
issues will still be avoided.
196+
3. If the `.*-height` class (or `transitionName.height`) is not specified the change in container height will not
197+
be animated but instead jump to the height of the entering component instantaneously. It can, therefore, be
198+
omitted if all content is known to be of the same height without any adverse side-effects, and absolute positioning
199+
related height issues will still be avoided.
198200

199201

200202
## Contributing

UPGRADE_GUIDE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Upgrade Guide
22

3+
## 1.3.0 -> 2.0.0
4+
5+
Components no longer unnecessarily unmount/mount during transition.
6+
They work just like regular React components now.
7+
8+
You can pass `transitionName={{ height: 'my-height-className' }}` now, if
9+
you need to use a custom className (useful for `css-modules`).
10+
11+
The leaving component will receive `isLeaving={true}` prop during it's leaving transition.
12+
You can use it in your child components to prevent their rerendering during that period, for example.
13+
14+
315
## 1.0.x -> 1.1.0
416

517
The entering component use to be positioned on top of the leaving component with

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,10 @@
7676
"vinyl-source-stream": "^1.1.0",
7777
"watchify": "^3.7.0"
7878
},
79-
"author": "Marnus Weststrate <[email protected]>",
79+
"authors": [
80+
"Marnus Weststrate <[email protected]>",
81+
"Leonid Nikiforenko <[email protected]"
82+
],
8083
"contributors": [],
8184
"keywords": [
8285
"react",

0 commit comments

Comments
 (0)