From d42397db72fd3e6ff7308971fd7b5f0e0d2e444f Mon Sep 17 00:00:00 2001 From: jwbrandon Date: Mon, 10 Aug 2026 15:40:31 -0400 Subject: [PATCH] docs(readme): nest props sections under a Props heading Add a parent `## Props` heading and demote Required Props, Optional Props, and API Functionality to `###`. The Contents list already linked to a `#props` anchor that no heading provided, so that entry pointed nowhere. Co-authored-by: Amo Wu --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1e82dac..d10da68 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,9 @@ const playlist = [{ ... ``` -## Required Props +## Props + +### Required Props These props are required to instantiate an instance of JW Player: * `library` @@ -97,7 +99,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`, `once` @@ -119,7 +121,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).