|
6 | 6 | Read our [announcement blog post](https://fabric.io/blog/introducing-the-velocityreact-library) for
|
7 | 7 | details about why and how we built this.
|
8 | 8 |
|
| 9 | +**Latest version:** 1.0.1 shims out Velocity to be compatible with server-side rendering |
| 10 | + |
9 | 11 | ## Running the demo
|
10 | 12 |
|
11 | 13 | ```
|
@@ -34,8 +36,8 @@ utilities, are distributed as ES5-compatible JavaScript files with [CommonJS](ht
|
34 | 36 | This package depends directly on Velocity, as well as [lodash](https://lodash.com/) for a handful
|
35 | 37 | of utility functions (which are required individually to try and keep bundle size down).
|
36 | 38 |
|
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. |
39 | 41 |
|
40 | 42 | ## Usage
|
41 | 43 |
|
@@ -146,9 +148,21 @@ You will need to manually register the UI Pack with the global Velocity in your
|
146 | 148 |
|
147 | 149 | See: http://julian.com/research/velocity/#uiPack
|
148 | 150 |
|
| 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 | + |
149 | 159 | ## Bugs
|
150 | 160 | Please report any bugs to: <https://github.com/twitter-fabric/velocity-react/issues>
|
151 | 161 |
|
| 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 | + |
152 | 166 | ## Acknowledgments
|
153 | 167 | Thanks to Julian Shapiro and Ken Wheeler for creating and maintaining Velocity, respectively,
|
154 | 168 | and for working with us to release this library.
|
|
0 commit comments