React-ESC-Resolver
Async-rendering & data-fetching for universal React applications.
React ESC Resolver lets you define data requirements per-component
and will handle the nested, async rendering on both the server & client for you.
For example, the following will load & provide this.props.user
for the
UserProfile
component:
import { resolve } from 'react-esc-resolver';
@resolve('user', function(props) {
return http.get(`/api/users/${props.params.userId}`);
})
class UserProfile extends React.Component {
render() {
const { user } = this.props;
...
}
}
This is the equivalent to asynchronously loading user
and providing it to
the component as if it were provided directly:
<UserProfile user={user} />
This makes components pure, stateless, and easy to test as a result.
Installation
$ npm install --save react-esc-resolver
Development
If you'd like to contribute to this project, all you need to do is clone
this project and run:
$ npm install
You can use npm link
to use your development version in your own project:
- Go to
react-esc-resolver
directory and execute command npm link
- Go to your project directory and execute command
npm link react-esc-resolver
Internet Systems Consortium license
The MIT License (MIT)
Copyright (c) 2015 David Zukowski
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Collaboration
If you have questions or issues, please open an issue!