Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/JedWatson/react-value

Adding Value to React
https://github.com/JedWatson/react-value

Last synced: about 1 month ago
JSON representation

Adding Value to React

Lists

README

        

# react-value

An easy easy way to wrap controlled components that provide `value` and `onChange` props with state.

Makes your components behave like React input components.

## Install

```
yarn add react-value
```

## Use

You can either use the `Value` component, which takes a `render` prop:

```jsx
import { Value } from 'react-value';

null} // optional
render={(value, onChange) => }
/>;
```

..or for repeated use, you can use the `withValue` HOC:

```jsx
import { withValue } from 'react-value';

const MyInputWithValue = withValue(MyInput);

;
```

### Custom Prop Names

If you want to use the HOC but the component you're wrapping uses different props for `value` and `onChange`, you can map them using the second options argument. For example, if the component expects `onValueUpdated` and `currentValue` props:

```jsx
import { withValue } from 'react-value';

const MyInputWithValue = withValue(MyInput, {
onChangeProp: 'onValueUpdated',
valueProp: 'currentValue',
});

;
```

# License

Copyright (c) 2018 Jed Watson. MIT Licensed.