react-redux-request

Declarative way to fetch data in React. Responses are stored in Redux.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-redux-request
1.5.66 years ago6 years agoMinified + gzip package size for react-redux-request in KB

Readme

Build Status NPM version dependencies Status
Redux is great for handling application state but requires a lot of generic boilerplate when it comes to data fetching: action creators, reducers, thunks/sagas and connected, stateful components. react-redux-request is a simple component that will fetch data, store it in Redux, and render it via a render prop.
Advantages over similar approaches:
  • Integrates seamlessly with Redux
  • BYOD (Bring-Your-Own-Datafetcher): no assumptions are made about how you fetch data. Just supply an async function, and the react-redux-request will call it and handle the resolve/rejected values.
  • Uses render props rather than higher-order-components (HOC)

Demo on Codesandbox

Install

yarn add react-redux-request

Getting started

import { createStore, combineReducers } from 'redux';
import { Provider } from 'react-redux';
import { Request, reducer } from 'react-redux-request';

// Add reducer to your store
const reducers = combineReducers({ reactReduxRequest: reducer });
const store = createStore(reducers);

// `getData` must return a promise
function getData() {
  return fetch(`https://jsonplaceholder.typicode.com/posts/1`).then(response =>
    response.json()
  );
}

const App = () => (
  <Provider store={store}>
    <Request
      fn={getData}
      id="post"
      render={({ status, data, error }) => <div>{status}</div>}
    />
  </Provider>
);

Run examples locally

npm start

Open localhost:6006 in your browser
All examples are located in https://github.com/sqren/react-redux-request/tree/master/stories

API

args: array

A list of arguments that will be applied to fn.
Example: ['a', 'b']

fn: func

A function to fetch data. This must return a promise that resolves with the response. Arguments can be supplied with args prop. This will only be invoked on initial mount, and when args change.

id: string

The identifier used to store the data in redux. If id is selected-user, the data will be stored in store.reactReduxRequest['selected-user']. This is useful if you have data you want to display different places in your application. By relying on redux as a cache, reactReduxRequest will only fetch the data once.

render: func

A so-called render-prop that will be called with the resolved or rejected value of fn. The render function is called with an object with these keys {status, data, error}

selector: func

This takes a selector (eg. from re-select) that will be called with state, { id }, where state is the entire store state, and id is the identifier supplied to the Request component.