@theonlyducks/videojs-zoom/README.md

Simple plugin to zoom in video.js player

# Video.js Zoom

> Simple plugin to zoom in video.js player

![Version](https://img.shields.io/github/package-json/v/theonlyducks/videojs-zoom)
![Project Size](https://img.shields.io/bundlephobia/min/@theonlyducks/videojs-zoom@latest)
![Dependencies](https://img.shields.io/github/languages/top/theonlyducks/videojs-zoom)
![Licence](https://img.shields.io/github/license/theonlyducks/videojs-zoom)

<img src="./preview.png" width="500" height="auto">

## Table of contents

- [Documentation](#documentation)
- [Getting started](#getting-started)
- [Methods](#methods)
- [Options](#options)
- [Development](#development)
- [License](#license)

## Documentation

## Getting started

### Requirements 

- With browser [Video.js](https://videojs.com/getting-started)
- With npm `npm istall video.js`
- With yarn `yarn add video.js`

### Installation

- With browser [Download](https://github.com/theonlyducks/videojs-zoom/releases/download/v1.3.4/dist.zip)
- With npm `npm install @theonlyducks/videojs-zoom@latest`
- With yarn `yarn add @theonlyducks/videojs-zoom@latest`

### Usage

- With Browser

```html
<link rel="stylesheet" type="text/css" href="/dist/videojs-zoom.css">
<script src="/dist/videojs-zoom.js"></script>
```

- With Node
```js
import '@theonlyducks/videojs-zoom/styles';
import '@theonlyducks/videojs-zoom';
```

### Example

```js
const video = videojs('my-video');
const zoomPlugin = video.zoomPlugin();
zoomPlugin.listen('change', data => {
	console.log(data);
});
```

## Methods

### zoom(value): void

Zoom function

- **value**
	- type: `Number`
	
```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.zoom(2);
```

### rotate(value): void

Rotate function

- **value**
	- type: `Number` in deg

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.rotate(180);
```

### move(x, y): void

Rotate function

- **x**
	- type: `Number`
- **y**
	- type: `Number`	

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.move(0, 0);
```

### toggle(): void

Open and close modal function

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.toggle();
```

### flip(signal): void

Flip video image

- **x**
	- type: `String` use + or - for flip image

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.flip("-");
```

### enablePlugin(): void

Enable the plugin if it is disabled

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.enablePlugin();
```

### disablePlugin(): void

Disables all visual features of the plugin if enabled

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.disablePlugin();
```

## Options

Example:
```js
const zoomPlugin = video.zoomPlugin({
	showZoom: true,
	showMove: true,
	showRotate: true,
	gestureHandler: false
});
```

- `showZoom` show/hide +- zoom buttons. default `true`
- `showMove` show/hide up, left, right, reset and down buttons. default `true`
- `showRotate` show/hide rotate and flip buttons. default `true`
- `gestureHandler` enable gesture zoom drag and drop, wheel. default `false`

## Events

### listen(event, callback): void

Listen events of the zoom plugin

- **event**
	- type: `String`
	- options: 
	  - `'change'` when click in buttons modal
	  - `'click'` when modal is opened or closed
- **callback**
	- type: `Function`

```js
const zoomPlugin = video.zoomPlugin();
zoomPlugin.listen('click', () => {
    console.log('click');
});
```

## Development

Install

```shell
yarn
```

Start server listening https://localhost:3000

```shell
yarn start
```

## License

[MIT](https://opensource.org/licenses/MIT) © [The Only Ducks](https://github.com/theonlyducks)