# videojs-theater-mode

> Adds a class the video.js container that can be used to put your video into "theater mode"

Latest version **1.0.0** (published 2017-06-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install videojs-theater-mode
pnpm add videojs-theater-mode
yarn add videojs-theater-mode
bun add videojs-theater-mode
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-06-27 |
| First published | 2017-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Jon |
| Maintainers | jgubman |
| Keywords | videojs, videojs-plugin, theater mode |

## Links

- npm: https://www.npmjs.com/package/videojs-theater-mode
- Repository: https://github.com/jgubman/videojs-theater-mode
- Homepage: https://github.com/jgubman/videojs-theater-mode#readme
- Issues: https://github.com/jgubman/videojs-theater-mode/issues
- npm.io page: https://npm.io/package/videojs-theater-mode

## Dependencies (2)

- [global](https://npm.io/package/global.md) ^4.3.2
- [video.js](https://npm.io/package/video.js.md) ^5.2.1

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

- 1.0.0 (latest) — 2017-06-27

## README

# videojs-theater-mode

Adds a class the video.js container that can be used to put your video into "theater mode"

## Installation

```sh
npm install --save videojs-theater-mode
```

## Usage

To include videojs-theater-mode on your website or web application, use any of the following methods. After including the script, have the player listen for the 'theaterMode' trigger and respond to the theaterModeIsOn: true/false object any way you'd like.

### `<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
<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-theater-mode.min.js"></script>
<script>
  var player = videojs('my-video');

  player.theaterMode({ elementToToggle: 'page');

  player.on('theaterMode', function(elm, data) {
    if (data.theaterModeIsOn) {
      $('#page').turnOnTheaterMode(); // or whatever
    } else {
      $('#page').turnOffTheaterMode();
    }
  });
</script>
```

### Browserify/CommonJS

When using with Browserify, install videojs-theater-mode via npm and `require` the plugin as you would any other module.

```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-theater-mode');

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

player.theaterMode({ elementToToggle: 'page' });

player.on('theaterMode', function(elm, data) {
  if (data.theaterModeIsOn) {
    $('#page').turnOnTheaterMode(); // or whatever
  } else {
    $('#page').turnOffTheaterMode();
  }
});
```

### 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-theater-mode'], function(videojs) {
  var player = videojs('my-video');
  player.theaterMode({ elementToToggle: 'page' });

  player.on('theaterMode', function(elm, data) {
    if (data.theaterModeIsOn) {
      $('#page').turnOnTheaterMode(); // or whatever
    } else {
      $('#page').turnOffTheaterMode();
    }
  });

});
```

## License

MIT. Copyright (c) Jon &lt;jon@jgubman.com&gt;


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

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