Skip to content

README is missing the Props section #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amowu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README is missing the Props section #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ const playlist = [{
...
```

## Required Props
## Props

### Required Props
These props are required to instantient an instance of JW Player:

* `library`
Expand All @@ -95,7 +97,7 @@ If you are not using a cloud hosted player you will need to provide a license ke
* Example: `{ key: "your-key-here" }`


## Optional Props
### Optional Props
**All JW Player config options** can be used individually as props to configure a `jwplayer-react` player, i.e., `advertising`, `analytics`, `playlist`, `related`, `width`, and `height`. See the full list [here](https://developer.jwplayer.com/jwplayer/docs/jw8-player-configuration-reference). In addition, you may use the following props:

* `on<Event>`, `once<Event>`
Expand All @@ -117,7 +119,7 @@ If you are not using a cloud hosted player you will need to provide a license ke
* Type: `({ player: PlayerAPI, id: string }) => void`
* Example: See [advanced implementation example](#advanced-implementation-examples)

## API Functionality
### API Functionality
For advanced usage,`jwplayer-react` creates an instance of the player API when mounted, and sets it to `this.player`, exposing all api functionality listed [here](https://developer.jwplayer.com/jwplayer/docs/jw8-javascript-api-reference).


Expand Down