react-jw-player-ts/README.md

A fork of react-jw-player rewritten in typescript

# react-jw-player-ts
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)


A typescript version of `<ReactJWPlayer>` – a React component for initialization and control over client-side instances of [JWPlayer](https://jwplayer.com/).
## Intro
The project originally started as a fork of the existing [react-jw-player](https://github.com/micnews/react-jw-player) library and then evolved into a standalone repo with a redesigned and fully typed codebase. At the moment, the package is at its alpha stage with most of the planned features still being under development. 

**Already done**\
:white_check_mark:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;upgrade React packages to support React 17\
:white_check_mark:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;use custom eslint config\
:white_check_mark:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;replace Tape test runner with Jest\
:white_check_mark:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;rewrite original codebase in typescript\
:white_check_mark:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cleanup and update component's props and events

**In progress**\
:x:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;provide a complete typing of configuration props and events\
:x:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;update component's interface to support the most recent edition of JWplayer API (v8.23.2)\
:x:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;rewire props to native JSON API\
:x:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cover the component with new tests\
:x:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;write a thorough documentation

## Installation
:warning:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FOR TESTING ONLY: currently not recommended for production use&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;:warning:
```shell
npm install react-jw-player-ts
```

## Usage

...under development...

## License
MIT