Skip to content
This repository was archived by the owner on Nov 3, 2021. It is now read-only.

Commit ac502a9

Browse files
committed
Merge pull request #24 from twitter-fabric/release-1.0.1
Release bump for v1.0.1
2 parents 6fb1d55 + 8b47081 commit ac502a9

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### v1.0.1 (2015-10-05):
2+
3+
#### Bug fixes
4+
* Shims out Velocity when running on the server so that the components all no-op
5+
6+
### v1.0.0 (2015-09-29):
7+
8+
Initial release! Contains `VelocityComponent` and `VelocityTransitionGroup`.
9+
10+
Read the [blog post](https://fabric.io/blog/introducing-the-velocityreact-library) and
11+
enjoy the demos.

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
Read our [announcement blog post](https://fabric.io/blog/introducing-the-velocityreact-library) for
77
details about why and how we built this.
88

9+
**Latest version:** 1.0.1 shims out Velocity to be compatible with server-side rendering
10+
911
## Running the demo
1012

1113
```
@@ -34,8 +36,8 @@ utilities, are distributed as ES5-compatible JavaScript files with [CommonJS](ht
3436
This package depends directly on Velocity, as well as [lodash](https://lodash.com/) for a handful
3537
of utility functions (which are required individually to try and keep bundle size down).
3638

37-
It is assumed that your application already depends on React. The `VelocityTransitionGroup`
38-
component particularly requires the React addons at version 0.13 or higher.
39+
It is assumed that your application already depends on React 0.13. Support for React 0.14
40+
release candidates is coming soon.
3941

4042
## Usage
4143

@@ -146,9 +148,21 @@ You will need to manually register the UI Pack with the global Velocity in your
146148

147149
See: http://julian.com/research/velocity/#uiPack
148150

151+
### Server-side rendering
152+
153+
The `VelocityComponent` and `VelocityTransitionGroup` components are (as of v1.0.1) not
154+
incompatible with rendering on the server. At this stage, the components will just no-op
155+
and let the children render naturally. If your initial animation end states match
156+
natural rendering anyway this will be exactly what you want. Otherwise you may notice a
157+
flash when the JS is applied and the initial animations are resolved.
158+
149159
## Bugs
150160
Please report any bugs to: <https://github.com/twitter-fabric/velocity-react/issues>
151161

162+
**We welcome contributions!** Note that when testing local changes against local projects you’ll
163+
need to avoid `npm link` since it typically will cause duplicate instances of `React` in the client.
164+
(You’ll often see this manifest as `firstChild undefined` errors.)
165+
152166
## Acknowledgments
153167
Thanks to Julian Shapiro and Ken Wheeler for creating and maintaining Velocity, respectively,
154168
and for working with us to release this library.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "velocity-react",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "React components to wrap Velocity animations",
55
"main": "index.js",
66
"scripts": {
@@ -26,7 +26,7 @@
2626
"velocity-animate": "^1.2.3"
2727
},
2828
"peerDependencies": {
29-
"react": ">=0.13.0"
29+
"react": "^0.13.0"
3030
},
3131
"devDependencies": {
3232
"babel-core": "^5.8.25",

0 commit comments

Comments
 (0)