# react-props-provider

> Uses react context mechanism to provide props indirectly

Latest version **0.1.0** (published 2019-03-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-props-provider
pnpm add react-props-provider
yarn add react-props-provider
bun add react-props-provider
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-03-13 |
| First published | 2019-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | James Larsen |
| Maintainers | somesocks |
| Keywords | react, context |

## Links

- npm: https://www.npmjs.com/package/react-props-provider
- Repository: https://github.com/somesocks/react-props-provider
- Issues: https://github.com/somesocks/react-props-provider/issues
- npm.io page: https://npm.io/package/react-props-provider

## Dependencies (2)

- [react](https://npm.io/package/react.md) ^16.8.4
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## 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

- 0.1.0 (latest) — 2019-03-13

## README

# react-props-provider

```javascript
  import React from 'react'
  import { PropsProvider, PropsConsumer } from 'react-props-provider'

  let ExampleComponent = (props) => (
    <div>hello {props.name}</div>
  );
  ExampleComponent = PropsConsumer(ExampleComponent);

  let ExampleParent = (props) => (
    <ExampleComponent />
  );
  ExampleParent = PropsProvider(ExampleParent);

  // will render to <div>hello bob</div>
  let a = (<ExampleParent name="bob" />);
```

## API

<a name="react-props-provider"></a>

## react-props-provider : <code>object</code>
**Kind**: global namespace  

* [react-props-provider](#react-props-provider) : <code>object</code>
    * [.PropsConsumer(reactClass, propsFromContext)](#react-props-provider.PropsConsumer) ⇒
    * [.PropsProvider(reactClass, propsToContext)](#react-props-provider.PropsProvider) ⇒


* * *

<a name="react-props-provider.PropsConsumer"></a>

### react-props-provider.PropsConsumer(reactClass, propsFromContext) ⇒
```javascript
  import React from 'react'
  import { PropsConsumer } from 'react-props-provider'

  // an example component
  let ExampleComponent = (props) => (
    <div>{props.name}</div>
  );

  ExampleComponent = PropsConsumer(ExampleComponent);

  // name will always be bob, since the prop is defined directly
  let a = (<ExampleComponent name="bob" />);

  // if 'name' was provided by a parent component, it would be used
  let b = (<ExampleComponent />);
```

PropsConsumer is a React HOC that wraps a React class,
and returns a new React class that uses the props-provider context
to provide default props to the wrapped component

**Kind**: static method of [<code>react-props-provider</code>](#react-props-provider)  
**Returns**: a wrapped react class  
**Params**

- reactClass - the react class / function to wrap with a prop.
- propsFromContext <code>function</code> - an optional function to customize which context props you want to consume.


* * *

<a name="react-props-provider.PropsProvider"></a>

### react-props-provider.PropsProvider(reactClass, propsToContext) ⇒
```javascript
  import React from 'react'
  import { PropsProvider } from 'react-props-provider'

  // an example component
  let ExampleComponent = (props) => (
    <div>{props.name}</div>
  );

  ExampleComponent = PropsProvider(ExampleComponent);

  // ExampleComponent will provide 'name' as a contextual prop to any children
  let a = (<ExampleComponent name="bob" />);

```

PropsConsumer is a React HOC that wraps a React class,
and returns a new React class that uses the props-provider context
to provide default props to the wrapped component

**Kind**: static method of [<code>react-props-provider</code>](#react-props-provider)  
**Returns**: a wrapped react class  
**Params**

- reactClass - the react class / function to wrap with a prop.
- propsToContext <code>function</code> - an optional function to customize which props are provided.


* * *

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