README.md

redux-mount

Mount view-specific data on a path and change mounted values on the fly. No need to create reducers, actions, or selector yourself.

Single page apps often have views that depend on some kind of state to represent their variations. Rest of the app might not care about that state. Also, there might be a need to persist view-specific state while navigating through the app. Handling this state results in a lot of boilerplate as most of it is often repeated for every view.

redux-mount solves this by opinionated reducer, actions and helper for state selector.

Actions:

import { combineReducers } from 'redux'
import { actions, reducer, createSelector } from 'redux-mount'

const WHATEVER_STATE_KEY = '_mount'

const mainReducer = combineReducers({
  [WHATEVER_STATE_KEY]: reducer,
  // your other reducers...
})

// create redux store with mainReducer etc...

/////////////////////////////
// MOUNTING
/////////////////////////////

// mount on path
dispatch(actions.mount('user/new'))
// mount on path with initial data
dispatch(actions.mount('user/new'), { type: 'administrator', name: 'John Doe' })


/////////////////////////////
// CHANGING MOUNTED STATE
/////////////////////////////

// after mount, every 'set' action works on the object
// under 'user/new' mount path; until we unmount
dispatch(actions.set('type', 'moderator')

// clear currently mounted state to an empty object -> {}
dispatch(actions.clear())


/////////////////////////////
// UNMOUNTING
/////////////////////////////

// unmount from the route; leaves mounted data as it was at the moment of unmount
dispatch(actions.unmount())


/////////////////////////////
// SELECTING MOUNTED STATE
/////////////////////////////

// "appState" represents your redux state object
// retrieve currently mounted data
const mountSelector = createSelector(WHATEVER_STATE_KEY)
const mountedData = mountSelector(appState)