Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

use-provider

1.0.4 • Public • Published

use-provider

A React Hook that connects your components to multiple React Contexts.

version minified size downloads build

Installation

npm

npm install use-provider --save

yarn

yarn add use-provider

Usage

With this module you can create multiple React Contexts that are managed internally with useReducer and then connect your components to any of those Contexts through its Providers.

createProvider(initialState, reducer)

// providers.js
 
import { createProvider } from 'use-provider';
 
const initialStateA = { counter: 0 };
const reducerA = (state, action) => {
  switch (action.type) {
    case 'increment': {
      return { counter: state.counter + 1 };
    }
 
    default: {
      return state;
    }
  }
};
 
const initialStateB = { counter: 0 };
const reducerB = (state, action) => {
  switch (action.type) {
    case 'increment': {
      return { counter: state.counter + 1 };
    }
 
    default: {
      return state;
    }
  }
};
 
export const ProviderA = createProvider(initialStateA, reducerA);
export const ProviderB = createProvider(initialStateB, reducerB);
 
...
// index.js
 
...
 
import { ProviderA, ProviderB } from './providers';
 
ReactDOM.render(
  <ProviderA>
    <ProviderB>
      <App />
    </ProviderB>
  </ProviderA>,
  document.getElementById('root')
);
 
...

useProvider(provider)

Each time you call useProvider inside a component you are connecting the component to the provider's context. useProvider returns the current state and a dispatch function to send actions that update the context's state.

// App.js
 
...
 
import { useProvider } from 'use-provider';
import { ProviderA, ProviderB } from './providers';
 
const ChildComponent = React.memo(
  function ChildComponent() {
    const [stateA, dispatchA] = useProvider(ProviderA);
 
    return (
      <div>
        <p>Counter A: {stateA.counter}</p>
        <button onClick={() => dispatchA({ type: 'increment' })}>
          Increment state A
        </button>
      </div>
    );
  }
)
 
// NOTE: ChildComponent is using React.memo to only rerender when stateA is updated by either
// ChildCompenent or App, otherwise it would also rerender when App component updates stateB.
 
function App() {
  const [stateA, dispatchA] = useProvider(ProviderA);
  const [stateB, dispatchB] = useProvider(ProviderB);
 
  return (
    <div>
      <p>Counter A: {stateA.counter}</p>
      <p>Counter B: {stateB.counter}</p>
      <button onClick={() => dispatchA({ type: 'increment' })}>
        Increment state A
      </button>
      <button onClick={() => dispatchB({ type: 'increment' })}>
        Increment state B
      </button>
 
      <ChildComponent />
    </div>
  );
}
 
 
...

combineProviders([providers])

combineProviders lets you combine multiple providers into a single one. To connect components to any of the combined providers you do it calling useProvider(provider) passing the specific provider you want to use from the combined group.

// index.js
 
const CombinedProvider = combineProviders([
    ProviderA,
    ProviderB,
    ...
])
 
ReactDOM.render(
  <CombinedProvider>
    <App />
  </CombinedProvider>,
  document.getElementById('root')
);
 
 
// MyComponent.js
 
import { ProviderA } from './providers';
 
const MyComponent = () => {
  const [stateA, dispatchA] = useProvider(ProviderA);
 
  return(...);
}

License

MIT

Install

npm i use-provider

DownloadsWeekly Downloads

0

Version

1.0.4

License

MIT

Unpacked Size

10.4 kB

Total Files

4

Last publish

Collaborators

  • avatar