\n)\n```\n\nThe primitives `react-values` gives you seem simple at first, but they can be composed together to create complex behaviors that are still easy to reason about, in just a few lines of code.\n\n
\n\n### Why?\n\nWhile building an app with React, you end up building a lot of stateful components in the process. Whether at the UI kit level for things like toggles, tooltips, checkbox groups, dropdown, etc. Or at the app level for modals, popovers, sorting, filtering, etc.\n\nIn the process, you end up re-implementing run of the mill state handling logic all over the place—whether with `this.setState` or by adopting some \"state management framework\" and writing the same boilerplate over and over again. And for your components to be nicely reusable across your application you augment them to handle both \"controlled\" and \"uncontrolled\" use cases using `value` or `defaultValue`. And to make things a bit more manageable, you re-invent common transforms like `open`, `close`, `toggle`, `increment`, `decrement`, etc. in lots of different components. And if you're working with a team, you end up doing all of this in slightly different ways throughout your codebase.\n\nIn the end, you're now maintaing a lot more logic than necessary, duplicated in many different places in slightly different ways. It gets harder and harder to understand your app's data flow. All while your app's bundle size grows.\n\n`react-values` solves all of that with a few principles...\n\n
\n\n### Principles\n\n1. **Leverage render props.** It uses a render-prop-based API, exposing its state and a handful of convenient transform functions to you with the flexible function-as-children pattern.\n\n2. **Follow React's conventions.** Its components follow React's own naming conventions, using familiar concepts like `value/defaultValue`. This makes it extremely easy to slot into existing codebases or frameworks.\n\n3. **Follow JavaScript's conventions.** It exposes JavaScript's familiar, built-in methods like `setDate/setHours`, `push/pop`, `filter`, `concat`, etc. to avoid reinventing the wheel and forcing you to constantly read documentation.\n\n4. **Be extremely lightweight.** It's extremely lightweight (and tree-shakeable), with most components weighing just a few hundred bytes, so you can even import it from public-facing component libraries.\n\n5. **Prioritize convenience.** It's designed to provide convenient functions like `increment`, `toggle`, and smarter ones like `incrementDate`, `decrementMonth`, so you can build complex interactions in just a few lines of code.\n\n
\n\n### Examples\n\nTo get a sense for how you might use `react-values`, check out a few of the examples:\n\n* [**Basic Toggle**](https://ianstormtaylor.github.io/react-values/#/basic-toggle) — using a `Boolean` to create a simple toggle component.\n* [**Reusable Toggle**](https://ianstormtaylor.github.io/react-values/#/reusable-toggle) — showing how you might turn that toggle into a controlled component in your own UI kit.\n* [**Counter**](https://ianstormtaylor.github.io/react-values/#/counter) — a simple counter using a `Number` and its convenience transforms.\n* [**Connected Counters**](https://ianstormtaylor.github.io/react-values/#/connected-counters) — two counters that are connected together, sharing a single value.\n* [**Time Picker**](https://ianstormtaylor.github.io/react-values/#/time-picker) — a more complex time picker component, using `Date` and its convenience transforms.\n* [**Filtering**](https://ianstormtaylor.github.io/react-values/#/filtering) — a basic `String` value used for filtering a list.\n* [**Checkbox Set**](https://ianstormtaylor.github.io/react-values/#/checkbox-set) — using a `Set` to keep track of a checkbox group.\n* [**Simple Tooltip**](https://ianstormtaylor.github.io/react-values/#/tooltip) — a simplistic tooltip implemented as a `Boolean`.\n* [**Simple Modal**](https://ianstormtaylor.github.io/react-values/#/modal) — a simplistic modal implemented as a `Boolean`.\n* [**Connected Modal**](https://ianstormtaylor.github.io/react-values/#/connected-modal) — a modal whose opened/closed state is controllable from other components.\n\nIf you have an idea for an example that shows a common use case, pull request it!\n\n
\n\n### Documentation\n\nIf you're using `react-values` for the first time, check out the [Getting Started](./docs/guide.md) guide to familiarize yourself with how it works. Once you've done that, you'll probably want to check out the full [API Reference](http://docs.slatejs.org/react-values-core).\n\n* [**Getting Started**](./docs/guide.md)\n * [Installing `react-values`](./docs/guide.md#installing-react-values)\n * [Building a Component](./docs/guide.md#building-a-component)\n * [Introducing State](./docs/guide.md#introducing-state)\n * [Observing Changes](./docs/guide.md#observing-changes)\n * [Setting Defaults](./docs/guide.md#settings-defaults)\n * [Controlled vs. Uncontrolled](./docs/guide.md#controlled-vs-uncontrolled)\n * [Spreading Props](./docs/guide.md#spreading-props)\n* [**Reference**](./docs/reference.md)\n * [**Components**](./docs/reference.md#value)\n * [`
`](./docs/reference.md#value)\n * [``](./docs/reference.md#arrayvalue)\n * [``](./docs/reference.md#booleanvalue)\n * [``](./docs/reference.md#datevalue)\n * [``](./docs/reference.md#mapvalue)\n * [``](./docs/reference.md#numbervalue)\n * [``](./docs/reference.md#objectvalue)\n * [``](./docs/reference.md#setvalue)\n * [``](./docs/reference.md#stringvalue)\n * [**Connected Components**](./docs/reference.md#createvalue)\n * [`createValue`](./docs/reference.md#createvalue)\n * [`createArrayValue`](./docs/reference.md#createarrayvalue)\n * [`createBooleanValue`](./docs/reference.md#createbooleanvalue)\n * [`createDateValue`](./docs/reference.md#createdatevalue)\n * [`createMapValue`](./docs/reference.md#createmapvalue)\n * [`createNumberValue`](./docs/reference.md#createnumbervalue)\n * [`createObjectValue`](./docs/reference.md#createobjectvalue)\n * [`createSetValue`](./docs/reference.md#createsetvalue)\n * [`createStringValue`](./docs/reference.md#createstringvalue)\n\nIf even that's not enough, you can always [read the source itself](./src).\n\nThere are also translations of the documentation into other languages:\n\n* [中文 (Chinese)](https://github.com/chinanf-boy/react-values-zh)\n\nIf you're maintaining a translation, feel free to pull request it here!\n\n
\n\n### Contributing!\n\nAll contributions are super welcome! Check out the [Contributing instructions](./Contributing.md) for more info!\n\n`react-values` is [MIT-licensed](./License.md).\n","readmeFilename":"Readme.md","description":"A set of tiny, composable React components for handling state with render props.","keywords":["boolean","component","components","date","headless","map","mobx","number","prop","props","react","redux","render","renderless","set","state","stateful","string","type","types","value","values"],"repository":{"type":"git","url":"git://github.com/ianstormtaylor/react-values.git"},"license":"MIT"}![](\"./docs/images/banner.png\")
\n![](\"https://img.badgesize.io/https://unpkg.com/react-values/dist/react-values.min.js?compression=gzip&label=react--values\")
\n ![](\"https://img.shields.io/npm/v/react-values.svg?maxAge=3600&label=react-values&colorB=007ec6\")
\n