react-rxjs/README.md
2022-03-30 08:48:19 +02:00

59 lines
6.6 KiB
Markdown

# <img height="86" width="86" alt="React-RxJS Logo" src="assets/logo-128.png" /> React-RxJS
<!-- prettier-ignore-start -->
[![Build Status](https://img.shields.io/github/workflow/status/re-rxjs/react-rxjs/CI?style=flat-square)](https://github.com/re-rxjs/react-rxjs/actions)
[![codecov](https://img.shields.io/codecov/c/github/re-rxjs/react-rxjs.svg?style=flat-square)](https://codecov.io/gh/re-rxjs/react-rxjs)
[![version](https://img.shields.io/npm/v/@react-rxjs/core.svg?style=flat-square)](https://www.npmjs.com/package/@react-rxjs/core)
[![MIT License](https://img.shields.io/npm/l/react-rxjs.svg?style=flat-square)](https://github.com/re-rxjs/react-rxjs/blob/main/LICENSE)
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Code of Conduct](https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square)](https://github.com/re-rxjs/react-rxjs/blob/main/CODE_OF_CONDUCT.md)
<!-- prettier-ignore-end -->
React-RxJS is a library that offers [React](https://reactjs.org/) bindings for [RxJS](https://rxjs.dev/)
Please visit the website: https://react-rxjs.org
## Main features
- :cyclone: Truly Reactive
- :zap: Highly performant and free of memory-leaks
- :twisted_rightwards_arrows: First class support for React Suspense and [ready for Concurrent Mode](https://github.com/dai-shi/will-this-react-global-state-work-in-concurrent-mode#results)
- :scissors: Decentralized and composable, thus enabling optimal code-splitting
- :microscope: [Tiny and tree-shakeable](https://bundlephobia.com/result?p=@react-rxjs/core)
- :muscle: Supports TypeScript
## Installation
npm install @react-rxjs/core
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/josepot"><img src="https://avatars1.githubusercontent.com/u/8620144?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Josep M Sobrepere</b></sub></a><br /><a href="https://github.com/re-rxjs/react-rxjs/commits?author=josepot" title="Code">💻</a> <a href="#ideas-josepot" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-josepot" title="Maintenance">🚧</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=josepot" title="Tests">⚠️</a> <a href="https://github.com/re-rxjs/react-rxjs/pulls?q=is%3Apr+reviewed-by%3Ajosepot" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=josepot" title="Documentation">📖</a> <a href="#infra-josepot" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center"><a href="https://github.com/voliva"><img src="https://avatars2.githubusercontent.com/u/5365487?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Víctor Oliva</b></sub></a><br /><a href="#ideas-voliva" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/re-rxjs/react-rxjs/pulls?q=is%3Apr+reviewed-by%3Avoliva" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=voliva" title="Code">💻</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=voliva" title="Tests">⚠️</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=voliva" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.clayforthcarr.com"><img src="https://avatars3.githubusercontent.com/u/6012083?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ed</b></sub></a><br /><a href="#design-clayforthcarr" title="Design">🎨</a></td>
<td align="center"><a href="https://github.com/pgrimaud"><img src="https://avatars1.githubusercontent.com/u/1866496?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Pierre Grimaud</b></sub></a><br /><a href="https://github.com/re-rxjs/react-rxjs/commits?author=pgrimaud" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/bhavesh-desai-scratch"><img src="https://avatars3.githubusercontent.com/u/15194540?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bhavesh Desai</b></sub></a><br /><a href="https://github.com/re-rxjs/react-rxjs/pulls?q=is%3Apr+reviewed-by%3Abhavesh-desai-scratch" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=bhavesh-desai-scratch" title="Documentation">📖</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=bhavesh-desai-scratch" title="Tests">⚠️</a></td>
<td align="center"><a href="https://m1x.io"><img src="https://avatars1.githubusercontent.com/u/3485831?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matt Mischuk</b></sub></a><br /><a href="https://github.com/re-rxjs/react-rxjs/commits?author=mattmischuk" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/rikoe"><img src="https://avatars1.githubusercontent.com/u/3295115?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Riko Eksteen</b></sub></a><br /><a href="#infra-rikoe" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/re-rxjs/react-rxjs/pulls?q=is%3Apr+reviewed-by%3Arikoe" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=rikoe" title="Documentation">📖</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=rikoe" title="Code">💻</a> <a href="#ideas-rikoe" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/hoclun-rigsep"><img src="https://avatars.githubusercontent.com/u/20741358?v=4?s=100" width="100px;" alt=""/><br /><sub><b>hoclun-rigsep</b></sub></a><br /><a href="https://github.com/re-rxjs/react-rxjs/commits?author=hoclun-rigsep" title="Documentation">📖</a> <a href="#ideas-hoclun-rigsep" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/skve"><img src="https://avatars.githubusercontent.com/u/47612057?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Luke Shiels</b></sub></a><br /><a href="https://github.com/re-rxjs/react-rxjs/issues?q=author%3Askve" title="Bug reports">🐛</a> <a href="https://github.com/re-rxjs/react-rxjs/commits?author=skve" title="Code">💻</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!