This package has been deprecated

Author message:

This library is no longer being maintained. Please see https://github.com/ioof-holdings/redux-dynostore/issues/484 for more details.

@redux-dynostore/react-redux

Deprecated

This library is no longer being actively maintained.

IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing the usage of this library with more standard React and JavaScript patterns. Due to some technical constraints, we've also been unable to upgrade to the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.

At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:

• redux-dynamic-modules
• redux-injectors
• redux-injector
• redux-reducers-injector
• paradux

If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.

---

React bindings for redux-dynostore to provide dynamic redux features when a component is mounted.

Usage

import dynamic from '@redux-dynostore/react-redux'

export default dynamic('identifier', somethingDynamic(), somethingElseDynamic('with parameters'))(MyComponent)

Multiple Instances

The 'identifier' shown above is the key that will be used for all instances of the component. If multiple instances are required to not share dynamic features (i.e. redux reducers), the the createInstance function can be used:

import MyComponent from './MyComponent'

const MyComponent1 = MyComponent.createInstance('instance1')
const MyComponent2 = MyComponent.createInstance('instance2')

Options

An optional options object can be passed as the final parameter to the dynamic function:

export default dynamic('identifier', somethingDynamic(), { /* options */ })(MyComponent)

context

import CustomReactReduxContext from './CustomReactReduxContext'

export default dynamic('identifier', somethingDynamic(), { context: CustomReactReduxContext })(MyComponent)

This option overrides the context used for accessing the store in the React context. If you are overriding this value, you should also be overriding the context passed to any Provider and/or connect components as well. Please refer to the Redux documentation for more details on this use case.

DynamicProvider

dynamic components will not render when server-side rendering (SSR) your app unless you add a DynamicProvider somewhere near the root of of your component tree (anywhere above the the first dynamic component). This will allow the component to call their enhancers synchronously in the first render pass. You must also ensure that the DynamicProvider is also rendered when hydrating that app on the client.

import ReactDom from 'react'
import { Provider } from 'react-redux'
import dynamic, { DynamicProvider } from '@redux-dynostore/react-redux'

import store from './store'
import MyDynamicComponent from './MyDynamicComponent

ReactDom.render((
  <Provider store={store}>
    <DynamicProvider>
      <MyDynamicComponent />
    </DynamicProvider>
  </Provider>
), document.getElementById('root'))

You can also nest multiple DynamicProvider components within each other.

ReactDom.render((
  <Provider store={store}>
    <DynamicProvider>
      <ParentDynamicComponent>
        <DynamicProvider>
          <ChildDynamicComponent />
        </DynamicProvider>
      </ParentDynamicComponent>
    </DynamicProvider>
  </Provider>
), document.getElementById('root'))

One example of when you might do this is when composing multiple sub-apps together into a parent-app and each app could have their own DynamicProvider instance. However, it is important to that the root DynamicProvider does not get unmounted and remounted as this will another synchronous render pass to occur after the first render, which will produce warnings from React about cross component updates.

While not required for client-side rendering (CSR), DynamicProvider, it can also slightly improve performance of the first render pass, however, due to limited testing, there might be unforeseen impacts of using this in an a CSR context, so use it at your own risk.

Enhancers

Enhancers are used to provide additional wrappers around the passed component when it is mounted. The following enhancers are provided:

1. Reducers - dynamically attach reducers
2. Sagas - dynamically run sagas
3. Dispatch Action - dispatch actions when the component is mounted
4. Subspaced - mounts the component is in a subspace for the components identifier
   1. Namespaced Reducers - dynamically attach reducers that are namespaced with the component's identifier
   2. Subspaced Sagas - dynamically run sagas that are subspaced for the component's identifier
   3. Dispatch Namespaced Action - dispatch actions when the component is mounted that are namespaced with the component's identifier

Custom Enhancers

Enhancers can be created for many use cases by implementing the following interface:

const enhancer = identifier => store => Component => EnhancedComponent

Instance Enhancers

Additional enhancers can be injected on a specific instance of a dynamic component

const MyComponent1 = MyComponent.createInstance('instance1', subspaced())