Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add userAction.click to prevent pause/play when player is clicked #7495

Merged
merged 4 commits into from
Nov 10, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/guides/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
* [techCanOverridePoster](#techcanoverrideposter)
* [techOrder](#techorder)
* [userActions](#useractions)
* [userActions.click](#useractionsclick)
* [userActions.doubleClick](#useractionsdoubleclick)
* [userActions.hotkeys](#useractionshotkeys)
* [userActions.hotkeys.fullscreenKey](#useractionshotkeysfullscreenkey)
Expand Down Expand Up @@ -443,6 +444,40 @@ Defines the order in which Video.js techs are preferred. By default, this means

> Type: `Object`

### `userActions.click`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the documentation!


> Type: `boolean|function`

Controls how clicking on the player/tech operates. If set to `false`, clicking is disabled and will no longer cause the player to toggle between paused and playing.

```js
videojs('my-player', {
userActions: {
click: false
}
});
```

If undefined or set to `true`, clicking is enabled and toggles the player between paused and play. To override the default click handling, set `userActions.click` to a function which accepts a `click` event (in this example it will request Full Screen, the same as a `userAction.doubleClick`):

```js
function myClickHandler(event) = {
// `this` is the player in this context

if (this.isFullscreen()) {
this.exitFullscreen();
} else {
this.requestFullscreen();
}
};

videojs('my-player', {
userActions: {
click: myClickHandler
}
});
```

### `userActions.doubleClick`

> Type: `boolean|function`
Expand Down
Loading