Starting simple
This is my first post here. I decided to share some of the knowledge I earned through making every mistake you can possibly make -.- Everything I write here I have learned by reading blog posts, trying to understand what was done and trial and error. If there are mistakes or if you think of a better way to do things, please let me know in the comments. I always appreciate helpful tips!
Now, first things first. You need to install React and Redux. I assume you know how to do that. After you've set up your React application you need to install a tool called redux-thunk by using the command npm install redux-thunk
With all those installed, we can now look at the components we're going to need to make the magic happen!
What is this thunk thing?
Basically a thunk is a function called by another function. Wait... What? Yeah, that's how I reacted the first time I heard this statement. Let me show you an example:
function some_function() {
// do something
return function thunk() {
// do something thunky later
}
}
So, some_function is called, it does something and then it returns a new function with commands and possibly data for later execution.
Now what about Redux?
I don't want to go into the deepest depths of redux (most likely I couldn't anyway), so just a short explanation: It's a state container for javascript applications. It holds all the data you need for your application in one place. Every component within your application has its space in the state container where it looks for data. When the data changes, the component will change, too.
Actions
The idea is that you dispatch actions onto redux, and based on those actions the state is modified.
The funny thing is: An action doesn't do anything. It sounds like there is stuff going on, but there isn't. An action is just a plain object with a type key. Like this one:
// this is an action
{
type: "SOME_ACTION",
payload: {}
}
Most of the time you don't want to write the same object over and over, so there is a concept called Action Creators.
Action Creators
Action Creators do exactly what they sound like, they create the action objects for you.
const SOME_ACTION = "SOME_ACTION";
function create_action(data) {
return {
type: SOME_ACTION,
payload: data
}
}
So with those action creators you can now easily use the SOME_ACTION by calling create_action(data). Those action creators can be dispatched to redux by using dispatch(create_action(data)).
Reducers
After an action is dispatched, it will be passed onto a so called reducer. A reducer is a function which is given a state and an action. Depending on the action it will transform the state and then return the new state.
function someReducer(state, action) {
switch(action.type) {
case SOME_ACTION:
return {
...state,
data: action.payload
}
break;
default:
// the dispatched action is not in this reducer, return the state unchanged
return state;
}
}
More complex applications most likely have multiple reducers, each one responsible for a single part of the state. So it is important to never forget the default case where the reducer returns the state unchanged.
Important to notice that reducers are pure functions. They never call something like an API or dispatch another action to redux.
You talked about thunks!?
You remembered that. Okay, thunks again. I just mentioned that reducers are pure. But often we want to have some kind of API call or dispatch something depending on data or whatever... But we can't... reducers are pure... Redux-Thunk to the rescue!
Redux-Thunk is pretty easy to understand. It is a so-called middleware for the redux store. It looks at every single action being dispatched and if it is a function, it calls the function. There is nothing more to it. But this opens up a whole new world of fancy "actions" which are dispatched to redux.
You might ask, how do I get this little wonder into my store?
import { applyMiddleware, createStore } from 'redux';
import thunk from 'redux-thunk';
import rootReducer from './rootReducer';
import initialState from './initialState';
const middlewares = [thunk];
createStore(rootReducer, initialState, applyMiddleware(...middlewares));
Let's get some products
We want to load some products from our API. To do this, we first set our component in some kind of pending state, we show a loading spinner or something like that. Then we load the data and we decide whether or not we can just show the product list or display some kind of error message-
We start with setting up our action creators.
// action.js
export const FETCH_PRODUCTS_PENDING = 'FETCH_PRODUCTS_PENDING';
export const FETCH_PRODUCTS_SUCCESS = 'FETCH_PRODUCTS_SUCCESS';
export const FETCH_PRODUCTS_ERROR = 'FETCH_PRODUCTS_ERROR';
function fetchProductsPending() {
return {
type: FETCH_PRODUCTS_PENDING
}
}
function fetchProductsSuccess(products) {
return {
type: FETCH_PRODUCTS_SUCCESS
products: products
}
}
function fetchProductsError(error) {
return {
type: FETCH_PRODUCTS_ERROR
error: error
}
}
Now that we have our action creators, let's set up our reducer for the whole thing.
// reducer.js
import {FETCH_PRODUCTS_PENDING, FETCH_PRODUCTS_SUCCESS, FETCH_PRODUCTS_ERROR} from './actions';
const initialState = {
pending: false,
products: [],
error: null
}
export function productsReducer(state = initialState, action) {
switch(action.type) {
case FETCH_PRODUCTS_PENDING:
return {
...state,
pending: true
}
case FETCH_PRODUCTS_SUCCESS:
return {
...state,
pending: false,
products: action.payload
}
case FETCH_PRODUCTS_ERROR:
return {
...state,
pending: false,
error: action.error
}
default:
return state;
}
}
export const getProducts = state => state.products;
export const getProductsPending = state => state.pending;
export const getProductsError = state => state.error;
Okay, now we have a big part of the work done.
What's to note in the code above, are the three functions at the end of the reducer. Those are called selectors. Selectors are used to get defined parts of the state. In small applications they are overkill. But if you scale your app and it gets more and more complex, it gets really messy if you change something within your state. With selectors you need to change the selector and everything works fine.
I'll propably do a blog post about selectors, because I think they are really important to set up a scalable react/redux application.
Now where were we... Ah yes, big part of the work is done. The only thing left for us to do on the redux side is to write one of our fancy new actions.
// fetchProducts.js
import {fetchProductsPending, fetchProductsSuccess, fetchProductsError} from 'actions';
function fetchProducts() {
return dispatch => {
dispatch(fetchProductsPending());
fetch('https://exampleapi.com/products')
.then(res => res.json())
.then(res => {
if(res.error) {
throw(res.error);
}
dispatch(fetchProductsSuccess(res.products);
return res.products;
})
.catch(error => {
dispatch(fetchProductsError(error));
})
}
}
export default fetchProducts;
The action above is pretty simple. First we dispatch our pending action. Then we fetch the data from our API. We decode the json coming in into an object. Then we check for an error. If an error happend we throw it and call our error function. If everything went okay, we call the success action. The reducer handles the rest.
This is all about fetching data from a server...Nah, just kidding, it isn't. But this is how most posts about fetching data from an api end, right? But...
What about our application?
Oh, you want the products from your store to actually show in your react app? Okay okay, let's do this.
I assume you know how to connect your react app to your redux store using a provider. There are plenty of posts about this topic out there. After you've done that, you'll need a few components.
For me everything starts in a view. A view, for me, is a component which wraps up everything a user gets served into one parent component. This parent component has most of the connection to the redux store and shares the data with the components it encapsulates.
import React, { Component } from 'react';
import PropTypes from 'prop-types';
import { connect } from 'react-redux';
import { bindActionCreators } from 'redux';
import fetchProductsAction from 'fetchProducts';
import {getProductsError, getProducts, getProductsPending} from 'reducer';
import LoadingSpinner from './SomeLoadingSpinner';
import ProductList from './ProductList';
class ProductView extends Component {
constructor(props) {
super(props);
this.shouldComponentRender = this.shouldComponentRender.bind(this);
}
componentWillMount() {
const {fetchProducts} = this.props;
fetchProducts();
}
shouldComponentRender() {
const {pending} = this.props;
if(this.pending === false) return false;
// more tests
return true;
}
render() {
const {products, error, pending} = this.props;
if(!this.shouldComponentRender()) return <LoadingSpinner />
return (
<div className='product-list-wrapper'>
{error && <span className='product-list-error'>{error}</span>}
<ProductList products={products} />
</div>
)
}
}
const mapStateToProps = state => ({
error: getProductsError(state),
products: getProducts(state),
pending: getProductsPending(state)
})
const mapDispatchToProps = dispatch => bindActionCreators({
fetchProducts: fetchProductsAction
}, dispatch)
export default connect(
mapStateToProps,
mapDispatchToProps
)(ProductView );
So, a lot is going on here. We write a standard React component. Then we use connect to connect it to our redux store. Connect takes two parameters: One function mapStateToProps which maps parts of the state into your components props and one function mapDispatchToProps which maps functions into your props which are, when called, dispatched to redux.
Right at the end we put all those things together and voilá, we have a connection to our store.
In the mapStateToProps function we make use of our selectors we wrote earlier.
I like to add a function called shouldComponentRender to my view components and most of my components for that matter. I named it like this, because it's close to react's shouldComponentUpdate lifecycle method. It checks whether or not the component should render. If not, it renders a LoadingSpinner component.
I find it very beneficial to work like this, because the components are always reinitialized and all subcomponents are mounted again after the pending flag, which controls the rendering in this case, toggles. Therefore you can add redux state to a component's state in the constructor. (I don't want to talk about what goes into redux and what goes into component state, this is a topic for another post).
In most of my projects I found this one of the most annoying problems. Think of a component which renders a product. It is initialized by the data and then some subcomponents like a price calculator, which has a component state, is initialized in its constructor. When new data comes in, you need to do a check whether or not the calculator needs to reinitialize. With the shouldComponentRender function it's super easy to do so. Everytime the pending flag toggles (maybe because a new product is selected), everything reinitializes and is good to go.
Of course there are some reasons why you might have components within your view to not to rerender. If that's the case, just remove the shouldComponentRender function from your view and work with it within the subcomponents.
You can use some kind of fadeout/-in effect to improve the user experience.