# react-merged-context

> A simple library for creating a context provider that merges together the context values throughtout the React tree.

Latest version **1.0.2** (published 2020-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-merged-context
pnpm add react-merged-context
yarn add react-merged-context
bun add react-merged-context
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-11-17 |
| First published | 2020-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 23.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Bennett Hardwick |
| Maintainers | bennetthardwick |
| Keywords | react, reactjs, context |

## Links

- npm: https://www.npmjs.com/package/react-merged-context
- Repository: https://github.com/bennetthardwick/react-merged-context
- npm.io page: https://npm.io/package/react-merged-context

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-11-17
- 1.0.1 — 2020-11-17
- 1.0.0 — 2020-11-17

## README

# react-merged-context

A simple library for creating a context provider that merges together the context values throughtout the React tree.

Check it out in action at [react-merged-context.netlify.app](https://react-merged-context.netlify.app/).

## Installation

This package lives in [npm](https://www.npmjs.com/get-npm). To install the latest stable version, run the following command:

```bash
npm install react-merged-context
```

Or if you're using [yarn](https://classic.yarnpkg.com/en/docs/install/):

```bash
yarn add react-merged-context
```

## Usage

You can create a merged context provider by passing your context to the `createMergedProvider` method.
This will return a "merged context provider" which you can use 

```ts
import { createContext } from 'react';
import { createMergedProvider } from 'react-merged-context';

const MyContext = createContext({ name: 'Sarah' })
const MyContextProvider = createMergedProvider(MyContext);

const element = <MyContextProvider value={...}>
...
</MyContextProvider>;
```

### Getting the value

Since `createMergedProvider` just creates a "Provider" component, you can retrieve the value from the context using the normal methods - either through `Context.Consumer` or `useContext`.

### Objects

Merged context providers can be used to apply a diff to the context.

```ts
import { createContext } from 'react';
import { createMergedProvider } from 'react-merged-context';

const MyContext = createContext({ name: 'Bennett', age: 22 })
const MyContextProvider = createMergedProvider(MyContext);

const element = <MyContextProvider value={{ name: 'Sarah' }}>
  <MyContext.Consumer>
    ({ name, age }) => {
      // `name` is 'Sarah' but `age` is still 22
    }
  </MyContext.Consumer>
</MyContextProvider>;
```

### Arrays

Merged context providers can also be used to concat arrays.

```ts
import { createContext } from 'react';
import { createMergedProvider } from 'react-merged-context';

const MyContext = createContext([ 1, 2, 3 ])
const MyContextProvider = createMergedProvider(MyContext);

const element = <MyContextProvider value={[ 4, 5, 6 ]}>
  <MyContext.Consumer>
    (values) => {
      // values is [ 1, 2, 3, 4, 5, 6 ]
    }
  </MyContext.Consumer>
</MyContextProvider>;
```

### Resetting with React context providers

You can use normal context providers to reset the value of the context.

```ts
import { createContext } from 'react';
import { createMergedProvider } from 'react-merged-context';

const MyContext = createContext([ 1, 2, 3 ])
const MyContextProvider = createMergedProvider(MyContext);

const element = <MyContext.Provider value={[]}>
  <MyContextProvider value={[ 4, 5, 6 ]}>
    <MyContext.Consumer>
      (values) => {
        // values is [ 4, 5, 6 ]
      }
    </MyContext.Consumer>
  </MyContextProvider>;
</MyContext.Provider>
```

## Example

You can view the example live at [react-merged-context.netlify.app](https://react-merged-context.netlify.app/).

To run the example locally:
1. navigate to `example/`
2. install the dependencies by running `yarn`
3. run `yarn start` to start the dev server
4. navigate to `localhost:1234`

## License

[MIT](https://github.com/bennetthardwick/react-merged-context/blob/master/LICENSE).

---
_Source: https://npm.io/package/react-merged-context · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
