rofrischmann/fela

View on GitHub
packages/react-fela/README.md

Summary

Maintainability
Test Coverage
# React Fela

<img alt="npm version" src="https://badge.fury.io/js/react-fela.svg"> <img alt="npm downloads" src="https://img.shields.io/npm/dm/react-fela.svg"> <a href="https://bundlephobia.com/result?p=react-fela@latest"><img alt="Bundlephobia" src="https://img.shields.io/bundlephobia/minzip/react-fela.svg"></a>

Official [React](https://github.com/facebook/react) bindings for Fela.

This package only includes React bindings for [Fela](http://github.com/robinweser/fela).<br>
It assumes you already know about Fela and how to use it.

## Installation
```sh
yarn add react-fela
```
You may alternatively use `npm i --save react-fela`.

## Usage
For more information and best practices on how to effectively use this package, please check out the main [Fela Documentation - Usage with React](https://fela.js.org/docs/latest/guides/usage-with-react). You will find some useful examples and a basic introduction on how to use Fela with React.<br>
Checkout the [API Reference - react-fela](https://fela.js.org/docs/latest/api/react-fela/useFela) for further technical information on how the React/Preact/Inferno bindings work.


## License
Fela is licensed under the [MIT License](http://opensource.org/licenses/MIT).<br>
Documentation is licensed under [Creative Commons License](http://creativecommons.org/licenses/by/4.0/).<br>
Created with ♥ by [@robinweser](http://weser.io) and all the great contributors.