react-dependency-injection v1.1.0

react-dependency-injection

Straight forward dependency injection for React. It uses React context to encapsulate dependencies, and those dependencies can be injected to components via props at any node of your component tree.

This is a useful and well known pattern for larger applications, that I have used extensively for the last two years. It is especially needed for universal applications where services and app-wide dependencies can't be singletons you import and consume in your components: in that case the use of context avoid having to pass dependencies from root to leaves.

Relying on context is fine for static data: see How to safely use React context. For dependency injection, it is the right feature.

Install

yarn add react-dependency-injection
## or
## npm install react-dependency-injection

Example

You have an entry point to your app, rendering an App component: you have a function creating your app-wide dependencies like constants, i18n formatters, messages, store, router, data api, etc...

export default function render() {
    const dependencies = createDependencies()

    ReactDOM.render(
        <App { ...dependencies } />
        document.getElementById('root')
    )
}

In your App component, you simply map props to dependencies you later want to inject:

import { setDependencies } from 'react-dependency-injection'

function App(props) {
    return (
        <div>
            <Header />
            <View />
            <Footer />
        </div>
    )
}

export default setDependencies((props) => ({
    formatters: props.formatters,
    messages: props.messages
}))(App)

Then, as long as a dependency was provided, you can use it in any component:

import { inject } from 'react-dependency-injection'

function ArticleDateTime({ formatters, messages, date, format }) {
    return (
        <div>
            { messages.get('article.dateCreated') }
            <time>
                { formatters.formatDateTime(date, format) }
            </time>
        </div>
    );
}

export default inject('formatters', 'messages')(DateTime);

API

This packages offers two higher-order components:

• setDependencies(dependencies: Object|Function , options: Object)(component: Component): Component
• inject(...dependencies: String , options: Object)(component: Component): Component

Supported options:

• pure (default to true): by default, your components are wrapped with React PureComponent. Set to false to disable that behaviour.
• contextName(default to '__dependencies'): context key name of where dependencies are stored. You only need to change in case of a namespace collision.