consume-multiple-contexts

0.4.1 • Public • Published

consume-multiple-contexts

Build Status dependencies Status Coverage Status GitHub package version code style: prettier

Utility for consuming multiple react contexts. Look at the example.

Why?

It's common to have multiple contexts in React ecosystems and you need consuming them together in your components. In new context API is way for that but you must repeat consumers for every component. It's maybe good for few component but for large applications is pain. The module consume-multiple-contexts try to solve that problem.

Installation

You can add the consume-multiple-contexts to your project using npm:

npm i consume-multiple-contexts --save

Usage

I use example from React documentation.

const ThemeContext = React.createContext('light');
const UserContext = React.createContext();
 
class App extends React.Component {
  render() {
    const {signedInUser, theme} = this.props;
 
    return (
      <ThemeContext.Provider value={theme}>
        <UserContext.Provider value={signedInUser}>
          <Layout />
        </UserContext.Provider>
      </ThemeContext.Provider>
    );
  }
}
 
function Layout() {
  return (
    <div>
      <Sidebar />
      <Content />
    </div>
  );
}
 
function Content() {
  return (
    <ThemeContext.Consumer>
      {theme => (
        <UserContext.Consumer>
          {user => (
            <ProfilePage user={user} theme={theme} />
          )}
        </UserContext.Consumer>
      )}
    </ThemeContext.Consumer>
  );
}
 
function Sidebar() {
  return (
    <ThemeContext.Consumer>
      {theme => (
        <UserContext.Consumer>
          {user => (
            <ProfileSidebar user={user} theme={theme} />
          )}
        </UserContext.Consumer>
      )}
    </ThemeContext.Consumer>
  );
}
 

If you use consume-multiple-contexts module you can write:

import { createNamedContext, createMultipleContexts } from 'consume-multiple-contexts';
 
const ThemeContext = React.createContext('light');
const UserContext = React.createContext();
 
const withContext = createMultipleContexts(
    createNamedContext('theme', ThemeContext),
    createNamedContext('user', UserContext)
);
 
.
.
 
function Content() {
  return withContext(({ theme, user }) => (
    <ProfilePage theme={theme} user={user} />
  ));
}
 
function Sidebar() {
  return withContext(({ theme, user }) => (
    <ProfileSidebar theme={theme} user={user} />
  ));
}
 

Or if you like HOC you can write:

import { createNamedContext, withMultipleContextsFactory } from 'consume-multiple-contexts';
 
const ThemeContext = React.createContext('light');
const UserContext = React.createContext();
 
const multipleContexts = [
  createNamedContext('theme', ThemeContext),
  createNamedContext('user', UserContext)
];
const withContext = withMultipleContextsFactory(themeContext, userContext);
 
.
.
 
const Content = withContext(ProfilePage);
const Sidebar = withContext(ProfileSidebar);
 

Package Sidebar

Install

npm i consume-multiple-contexts

Weekly Downloads

6

Version

0.4.1

License

ISC

Unpacked Size

11.4 kB

Total Files

4

Last publish

Collaborators

  • mjancarik