Donkeyclip React Component
This README provides documentation and usage instructions for the Donkeyclip
React component. The Donkeyclip
component is designed to embed and control a donkeyclip in your React application.
Installation
To install the Donkeyclip
component in your project, run the following command:
npm install --save @donkeyclip/react
Usage
Import the Donkeyclip
component:
import Donkeyclip from "@donkeyclip/react";
Add the Donkeyclip
component to your JSX as follows:
<Donkeyclip
id="<your-clip's id>"
controls
initParams={{
// your initParams object
}}
/>
Props
The Donkeyclip
component accepts the following props:
-
id
: The ID of the donkeyclip you want to use. -
height
(optional): The height of the video player in pixels or percentage. If not provided, the player will default to the height of its parent container. -
width
(optional): The width of the video player in pixels or percentage. If not provided, the player will default to the width of its parent container. -
scaleToFit
(optional): A boolean or string value that, when set totrue
, scales the clip to fit the player dimensions. -
mcVersion
(optional): A string specifying the version of the MotorCortex library to use. -
playerVersion
(optional): A string specifying the version of the Donkeyclip Player library to use. -
theme
(optional): APlayerTheme
object that sets the player's theme.here. -
initParams
(optional): An object containing the initParams for initializing the clip. -
visible
(optional): A string value"always"
indicating that the player should always be visible. -
ms
(optional): A number or string value representing the millisecond at which the clip should start playing. -
definition
(optional): ADefinition
object or a string containing the JSON representation of aDefinition
object. -
volume
(optional): A number or string value representing the volume level of the clip. -
speed
(optional): A number or string value representing the playback speed of the clip. -
backgroundColor
(optional): A string value representing the background color of the player. -
spinnerColor
(optional): A string value representing the color of the loading spinner. -
metadata
(optional): ADonkeyClipMetadata
object containing metadata about the clip. -
handleChangeInitParams
(optional): A callback function that takes an optional object with a booleanresult
property, called when the initialization parameters change. -
onMillisecondChange
(optional): A callback function that takes a number parametertime
, called when the current playback time changes.