# @donkeyclip/react

> Donkeyclip React Wrapper

Latest version **2.3.0** (published 2026-05-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @donkeyclip/react
pnpm add @donkeyclip/react
yarn add @donkeyclip/react
bun add @donkeyclip/react
```

## Health

**Score 55/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2026-05-03 |
| First published | 2022-02-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 459 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Donkeyclip |
| Maintainers | alexdor, prieston, atrantidis |

## Links

- npm: https://www.npmjs.com/package/@donkeyclip/react
- npm.io page: https://npm.io/package/@donkeyclip/react

## Dependencies (1)

- [lodash-es](https://npm.io/package/lodash-es.md) ^4.18.1

## Recent versions

- 2.3.0 (latest) — 2026-05-03
- 2.2.1 — 2026-05-01
- 2.2.0 — 2026-04-29
- 2.1.44 — 2025-10-22
- 2.1.43 — 2025-10-22
- 2.1.40 — 2025-07-31
- 2.1.39 — 2025-07-31
- 2.1.38 — 2025-07-10
- 2.1.37 — 2025-07-09
- 2.1.36 — 2025-07-09
- 2.1.35 — 2025-07-09
- 2.1.34 — 2025-07-09
- 2.1.33 — 2025-07-09
- 2.1.32 — 2025-07-09
- 2.1.31 — 2025-07-09
- … 84 more at https://npm.io/package/@donkeyclip/react/versions

## README

# 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:

```bash
npm install --save @donkeyclip/react
```

## Usage

Import the `Donkeyclip` component:

```javascript
import Donkeyclip from "@donkeyclip/react";
```

Add the `Donkeyclip` component to your JSX as follows:

```jsx
<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 to `true`, 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): A `PlayerTheme` object that sets the player's theme.[here](https://github.com/donkeyclip/motorcortex-player).
- `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): A `Definition` object or a string containing the JSON representation of a `Definition` 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): A `DonkeyClipMetadata` object containing metadata about the clip.
- `handleChangeInitParams` (optional): A callback function that takes an optional object with a boolean `result` property, called when the initialization parameters change.
- `onMillisecondChange` (optional): A callback function that takes a number parameter `time`, called when the current playback time changes.

---
_Source: https://npm.io/package/@donkeyclip/react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._