# videojs-seek-buttons

> Plugin for video.js to add seek buttons to the control bar

Latest version **3.0.1** (published 2022-10-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install videojs-seek-buttons
pnpm add videojs-seek-buttons
yarn add videojs-seek-buttons
bun add videojs-seek-buttons
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2022-10-18 |
| First published | 2016-01-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | separate (@types/videojs-seek-buttons) |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 1 |
| Unpacked size | 41.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 89 |
| Author | mister-ben |
| Maintainers | misterben |
| Keywords | videojs, videojs-plugin |

## Links

- npm: https://www.npmjs.com/package/videojs-seek-buttons
- Repository: https://github.com/mister-ben/videojs-seek-buttons
- Homepage: https://github.com/mister-ben/videojs-seek-buttons#readme
- Issues: https://github.com/mister-ben/videojs-seek-buttons/issues
- npm.io page: https://npm.io/package/videojs-seek-buttons

## Dependencies (1)

- [global](https://npm.io/package/global.md) ^4.4.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2022-10-18
- 4.0.3 (next) — 2023-05-04
- 1.5.0-beta0 (beta) — 2019-02-24
- 4.0.2 — 2023-01-17
- 4.0.1 — 2022-11-23
- 4.0.0 — 2022-11-23
- 4.0.0-1 — 2022-11-21
- 3.0.0 — 2022-09-19
- 2.2.1 — 2022-04-23
- 2.2.0 — 2021-10-06
- 2.1.0 — 2021-07-20
- 2.0.1 — 2021-06-06
- 2.0.0 — 2021-05-31
- 1.6.0 — 2020-05-09
- 1.5.0 — 2019-04-18
- … 5 more at https://npm.io/package/videojs-seek-buttons/versions

## README

# videojs-seek-buttons

Plugin for video.js to add seek buttons to the control bar. These buttons allow the user to skip forward or back by a configured number of seconds.

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Installation](#installation)
- [Options](#options)
  - [Control position](#control-position)
- [Usage](#usage)
  - [`<script>` Tag](#script-tag)
  - [Browserify/CommonJS](#browserifycommonjs)
  - [RequireJS/AMD](#requirejsamd)
- [License](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Installation

```sh
npm install video.js
npm install videojs-seek-buttons
```

Version 3.x requires video.js version 6.x or 7.x to be installed as a peer dependency (latest v7 is recommended).

## Options

- `forward` - if a number greater than 0, a seek forward button will be added which seeks that number of seconds
- `back` - if a number greater than 0, a seek back button will be added which seeks that number of seconds
- `forwardIndex` - the position in the control bar to insert the button. Defaults to `1`. See note below.
- `backIndex` - the position in the control bar to insert the button. Defaults to `1`. See note below.

### Control position

`forwardIndex` and `backIndex` set the posiiton of the button in the control bar. Note if both a back and forward button are used, the forward button is inserted first.

Assuming the standard control bar, the play button is at index `0`. With the default index of `1` for both, the forward button is inserted after the play button, then the back button is inserted after the play button and before the forward button. Setting `backIndex` to `0` would place the back button before the play button instead, so they surround the play button.

## Usage

To include videojs-seek-buttons on your website or web application, use any of the following methods to include the script.

You also need to include the plugin's CSS.

### `<script>` Tag

This is the simplest case. Get the script in whatever way you prefer and include the plugin _after_ you include [video.js][videojs], so that the `videojs` global is available.

```html
<link rel="stylesheet" href="//path/to/video-js.css">
<link rel="stylesheet" href="//path/to/videojs-seek-buttons.css">
<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-seek-buttons.min.js"></script>
<script>
  var player = videojs('my-video');

  player.seekButtons({
    forward: 30,
    back: 10
  });


// You could alternatively include the plugin in the setup options, e.g.
// var player = videojs('my-video', {
//   plugins: {
//     seekButtons: {
//       forward: 30,
//       back: 10
//     }
//   }
// });

</script>
```

The dist versions will be available from services which host npm packages such as jsdelivr:

* https://cdn.jsdelivr.net/npm/videojs-seek-buttons/dist/videojs-seek-buttons.min.js
* https://cdn.jsdelivr.net/npm/videojs-seek-buttons/dist/videojs-seek-buttons.css

### Browserify/CommonJS

When using with Browserify, install videojs-seek-buttons via npm and `require` the plugin as you would any other module.
Make sure if using React to also `include "videojs-seek-buttons/dist/videojs-seek-buttons.css"`, otherwise the icons will not appear in the control bar.

```js
var videojs = require('video.js');

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-seek-buttons');

var player = videojs('my-video');

player.seekButtons({
    forward: 30,
    back: 10
  });
```

### RequireJS/AMD

When using with RequireJS (or another AMD library), get the script in whatever way you prefer and `require` the plugin as you normally would:

```js
require(['video.js', 'videojs-seek-buttons'], function(videojs) {
  var player = videojs('my-video');

  player.seekButtons({
    forward: 30,
    back: 10
  });
});
```

## License

Apache-2.0. Copyright (c) mister-ben &lt;git@misterben.me&gt;


[videojs]: http://videojs.com/

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