react-player-controls


 


This is a minimal set of modular, tested and hopefully useful React components for composing media player interfaces. It is designed for you to compose media player controls yourself using a small and easy-to-learn API.

> 👴 Check the old README for version 0.5.x, which contained more pre-baked components, if you are still on that version. 👵

From a library point of view, creating and providing components like or tends to result in abstractions with tons of props, often preventing arbitrary customisation, whilst providing little real value. These abstractions prove especially hindering when it comes to styling child elements. Therefor, instead of shipping these composite components, there is a collection of recipies that you can more or less copy-paste right into your project. Along with these plain components are a few boilerplate sets of styles in different forms that you can use if you want.

You can see the base components in action on the examples page.

⚠️ NOTE: This library does not deal with actual media in any way, only the UI. ⚠️

$3

* Installation
* Usage
* API
* Recipies
* Contribute

Installation

``sh
npm i react-player-controls
`

Usage

`js
// ES2015+ import
import { Slider, Direction } from 'react-player-controls'

// Using CommonJS
const { Slider, Direction } = require('react-player-controls')
`

API

*
* Direction
*
*
*

$3

is basically a simple HTML button.

`js


alert('clicked')}>
Click me

`

| Prop name | Default value | Description |
|-----------|---------------|-------------|
| onClick | - | Required. A callback function that is invoked when the button is clicked. |
| isEnabled | true | Whether the button is enabled. Setting this to false will set the disabled attribute on the button element to true. |
| className | null | A string to set as the HTML class attribute |
| style | {} | Styles to set on the button element. |
| children | null | Child elements. |

$3

An enum describing a slider's active axis.

| Key | Value |
|-----|-------|
| HORIZONTAL | "HORIZONTAL" |
| VERTICAL | "VERTICAL" |

$3

translates a number of seconds into the player-friendly format of m:ss, or h:mm:ss if the total time is one hour or higher.

`js
// This will render -1:01:02

`

| Prop name | Default value | Description |
|-----------|---------------|-------------|
| numSeconds | 0 | A number of seconds, positive or negative |
| className | null | A string to set as the HTML class attribute |
| style | {} | Styles to set on the wrapping span element. |

$3

is not really a component in itself, but a container of a number of icon components.

`js






`

Any props passed to a component will be passed onto the underlying svg element.

$3

The helps you build things like volume controls and progress bars. Slightly counterintuitively, it does not take a value prop, but expects you to keep track of this yourself and render whatever you want inside it.

What this component actually does is that it renders an element inside itself, on top of its children, which listens to mouse events and invokes change and intent callbacks with relative, normalised values based on those events.

`js
direction={Direction.HORIZONTAL}
isEnabled
onIntent={intent => console.log(hovered at ${intent})}
onIntentStart={intent => console.log(entered with mouse at ${intent})}
onIntentEnd={() => console.log('left with mouse')}
onChange={newValue => console.log(clicked at ${newValue})}
onChangeStart={startValue => console.log(started dragging at ${startValue})}
onChangeEnd={endValue => console.log(stopped dragging at ${endValue})}
>
{/ Here we render whatever we want. Nothings is rendered by default. /}

`

| Prop name | Default value | Description |
|-----------|---------------|-------------|
| direction | Direction.HORIZONTAL | The slider's direction |
| isEnabled | true | Whether the slider is interactable |
| onIntent | () => {} | A function that is invoked with the relative, normalised value at which the user is hovering (when not dragging). |
| onIntentStart | () => {} | A function this is invoked with the relative, normalised value at which the user started hovering the slider (when not dragging). |
| onIntentEnd | () => {} | A function this is invoked when the mouse left the slider area (when not dragging). |
| onChange | () => {} | A function that is invoked with the latest relative, normalised value that the user has set by either clicking or dragging. |
| onChangeStart | () => {} | A function that is invoked with the relative, normalised value at which the user started changing the slider's value. |
| onChangeEnd | () => {} | A function that is invoked with the relative, normalised value at which the user stopped changing the slider's value. When the component unmounts, this function will be invoked with a value of null. |
| children | null | Child elements. |
| className | null | A string to set as the HTML class attribute. |
| style | {} | Styles to set on the wrapping div element. |
| overlayZIndex | 10 | The z-index of the invisible overlay that captures mouse events |

Recipies