react-redux-model v0.6.0

react-redux-model

Simple to use XHR fetching and model-oriented utility functions.

tl;dr

Most applications have common and consistent needs. Load data using XHR and know the fetch status so it can be represented with a loading indicator. This lib provides action creators, reducers and React component wrappers that work with each other to simplify and DRY up your code.

More Details

There are ties between action creators, reducers and state-aware components in that

• action creators have to supply the action type that the reducers will be scanning for
• reducers have to save state where state-aware components will be pulling from
• this pattern is common for almost every bit of XHR data that we retrieve so why not DRY that up?

Goals of this project

• Make XHR fetching easy and be able to support multiple XHR libs
• Make reducer creation easy
• Provide a component wrapper that will auto-fetch your models
• Support normalizr
• Support collections
• Auto-add model object (wrapper of your plain old JSON) to your React component
• Support additional model specific "XHR actions"

Examples

• simple profile viewer using github API (demonstrating XHR auto-fetch and loading state indication)
• simple github project search using github API (demonstrating collections)
• previous example with paging using custom model class
• previous example with normalized entities using normalizr and helpful debug settings
• previous example with additional project details page (demonstrating no additional XHR fetch for details page because of normalized entities)

Docs

• Action Creator (using redux-effects)
• Model Provider React component
• Model Class
• Model Reducer

Installation

npm install --save react-redux-model

If using the redux-effects based action creator

npm install --save react-redux-model redux-effects redux-effects-fetch redux-multi

And apply the middleware dependencies

import effects from 'redux-effects';
import fetch from 'redux-effects-fetch';
import multi from 'redux-multi';

applyMiddleware(multi, effects, fetch);