# vjs-downloader
A download button plugin for Video.js that adds a download button to the video player's control bar.
## Features
- Adds a download button to Video.js player's control bar
- Customizable download button position
- Support for custom download URLs
- Custom download handler support
- Responsive design with flexible icon sizing
## Installation
```bash
npm install vjs-downloader
```
## Usage
### Basic Usage
```javascript
// Import the plugin
import vjsDownloader from 'vjs-downloader';
import 'vjs-downloader/dist/vjs-downloader.min.css';
// Register the plugin
videojs.registerPlugin('vjsDownloader', vjsDownloader);
// Initialize video.js player with the plugin
const player = videojs('my-video', {
plugins: {
vjsDownloader: {
// Optional configuration
controlText: 'Download Video',
className: 'vjs-downloader'
}
}
});
```
### HTML Example
```html
```
### Vue Example
```vue
```
## Configuration Options
The plugin accepts the following configuration options:
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `beforeElement` | String | "fullscreenToggle" | The name of the control bar element before which the download button should be inserted |
| `controlText` | String | "Download" | The text to display for the download button |
| `downloadURL` | String | null | Custom URL for downloading. If not provided, uses the current video source URL |
| `customDownload` | Boolean | false | If true, triggers a custom download event instead of opening the URL |
| `className` | String | 'vjs-downloader' | CSS class name for the download button |
## Events
The plugin triggers the following events:
- `download`: Triggered when the download button is clicked
## Browser Support
- Chrome
- Firefox
- Safari
- Edge
- IE11 (with polyfills)
## License
ISC