Skip to content

feat: Add global hotkey support #8906

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.

Sign up for GitHub

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

Open
sinaru wants to merge 2 commits into
base: main
Choose a base branch
from
+221 −0
Open

feat: Add global hotkey support #8906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c377e17
feat: global hotkey support
sinaru Nov 2, 2024
801d0bf
Add sandbox example for global hotkeys
sinaru Mar 8, 2025
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
149 changes: 149 additions & 0 deletions sandbox/global-hotkeys.html.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Video.js Sandbox</title>
<link href="../dist/video-js.css" rel="stylesheet" type="text/css">
<script src="../dist/video.js"></script>
</head>
<body>
<div
style="background-color:#eee; border: 1px solid #777; padding: 10px; margin-bottom: 20px; font-size: .8em; line-height: 1.5em; font-family: Verdana, sans-serif;">
<p>Focus outside the player (e.g. click anywhere in the page) and press a hotkey (e.g. space bar).
The player hotkey should trigger and perform the action.</p>
<p>By setting <code>globalHotkeys: true</code> extends the normal hotkey behavior at the global level. Therefore
<code>hotkeys: true</code> also need to be set.</p>
<p>Note that if the focus is on an interactive element in the page, the global hotkey behavior would not trigger.</p>
</div>

<div>
<h2>Player with default hotkeys</h2>
<video-js
id="vid1"
controls
preload="auto"
width="640"
height="264"
poster="https://vjs.zencdn.net/v/oceans.png">
<source src="https://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
<source src="https://vjs.zencdn.net/v/oceans.webm" type="video/webm">
<source src="https://vjs.zencdn.net/v/oceans.ogv" type="video/ogg">
<track kind="captions" src="../docs/examples/shared/example-captions.vtt" srclang="en" label="English">
<p class="vjs-no-js">To view this video please enable JavaScript, and consider upgrading to a web browser that <a
href="https://videojs.com/html5-video-support/" target="_blank">supports HTML5 video</a></p>
</video-js>

<h2>Player with 'x' button linked to play/pause</h2>
<video-js
id="vid2"
controls
preload="auto"
width="640"
height="264"
poster="https://vjs.zencdn.net/v/oceans.png">
<source src="https://vjs.zencdn.net/v/oceans.mp4" type="video/mp4">
<source src="https://vjs.zencdn.net/v/oceans.webm" type="video/webm">
<source src="https://vjs.zencdn.net/v/oceans.ogv" type="video/ogg">
<track kind="captions" src="../docs/examples/shared/example-captions.vtt" srclang="en" label="English">
<p class="vjs-no-js">To view this video please enable JavaScript, and consider upgrading to a web browser that <a
href="https://videojs.com/html5-video-support/" target="_blank">supports HTML5 video</a></p>
</video-js>

<script>
var player1 = videojs('vid1', {
userActions: {
globalHotkeys: true,
hotkeys: true
}
});
player1.log('window.player 1 created', player1);
var player2 = videojs('vid2', {
userActions: {
globalHotkeys: true,
hotkeys: function (event) {
// `x` key = play/pause
if (event.which === 88) {
this.paused() ? this.play() : this.pause();
}
}
}
});
player2.log('window.player 2 created', player2);
</script>
</div>

<div id="test-interactive-area" style="margin-top: 50px">
<h2>Test Interactive Area</h2>

<div>
<label for="sample-input">Sample Input:</label>
<input id="sample-input" type="text" name="foo" value="bar">
</div>

<div>
<label for="sample-password">Password:</label>
<input id="sample-password" type="password" name="password">
</div>

<div>
<label for="sample-checkbox">
<input id="sample-checkbox" type="checkbox"> Check me
</label>
</div>

<div>
<label for="sample-radio1">
<input id="sample-radio1" type="radio" name="sample-radio" value="option1"> Option 1
</label>
<label for="sample-radio2">
<input id="sample-radio2" type="radio" name="sample-radio" value="option2"> Option 2
</label>
</div>

<div>
<label for="sample-select">Choose an option:</label>
<select id="sample-select">
<option value="1">Option 1</option>
<option value="2">Option 2</option>
<option value="3">Option 3</option>
</select>
</div>

<div>
<label for="sample-textarea">Sample Textarea:</label>
<textarea id="sample-textarea" rows="4" cols="50">This is a sample textarea with some test content.</textarea>
</div>

<div>
<label for="sample-range">Select range:</label>
<input id="sample-range" type="range" min="0" max="100">
</div>

<div>
<label for="sample-date">Pick a date:</label>
<input id="sample-date" type="date">
</div>

<div>
<label for="sample-color">Pick a color:</label>
<input id="sample-color" type="color">
</div>

<div>
<p>This is a sample paragraph with some interactive content.</p>
</div>

<div>
<ul>
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
</ul>
</div>

<div>
<button onclick="alert('Button clicked!')">Click Me</button>
</div>
</div>
</body>
</html>
17 changes: 17 additions & 0 deletions src/js/player.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,8 @@ class Player extends Component {

this.boundUpdatePlayerHeightOnAudioOnlyMode_ = (e) => this.updatePlayerHeightOnAudioOnlyMode_(e);

this.boundGlobalKeydown_ = (e) => this.handleGlobalKeydown_(e);

// default isFullscreen_ to false
this.isFullscreen_ = false;

Expand Down Expand Up @@ -615,6 +617,10 @@ class Player extends Component {
this.on('keydown', (e) => this.handleKeyDown(e));
this.on('languagechange', (e) => this.handleLanguagechange(e));

if (this.isGlobalHotKeysEnabled()) {
Events.on(document.body, 'keydown', this.boundGlobalKeydown_);
}

this.breakpoints(this.options_.breakpoints);
this.responsive(this.options_.responsive);

Expand Down Expand Up @@ -650,6 +656,7 @@ class Player extends Component {
// Make sure all player-specific document listeners are unbound. This is
Events.off(document, this.fsApi_.fullscreenchange, this.boundDocumentFullscreenChange_);
Events.off(document, 'keydown', this.boundFullWindowOnEscKey_);
Events.off(document.body, 'keydown', this.boundGlobalKeydown_);

if (this.styleEl_ && this.styleEl_.parentNode) {
this.styleEl_.parentNode.removeChild(this.styleEl_);
Expand Down Expand Up @@ -2251,6 +2258,12 @@ class Player extends Component {
this.trigger('textdata', data);
}

handleGlobalKeydown_(event) {
if (event.target === document.body) {
this.handleKeyDown(event);
}
}

/**
* Get object for cached values.
*
Expand Down Expand Up @@ -4574,6 +4587,10 @@ class Player extends Component {
this.height(this.audioOnlyCache_.controlBarHeight);
}

isGlobalHotKeysEnabled() {
return !!(this.options_ && this.options_.userActions && this.options_.userActions.globalHotkeys);
}

enableAudioOnlyUI_() {
// Update styling immediately to show the control bar so we can get its height
this.addClass('vjs-audio-only-mode');
Expand Down
55 changes: 55 additions & 0 deletions test/unit/player-user-actions.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,3 +639,58 @@ QUnit.test('hotkeys are NOT ignored when focus is on a button input', function(a
defaultKeyTests.mute(this.player, assert, true);
defaultKeyTests.playPause(this.player, assert, true);
});

QUnit.module('Player: User Actions: Global Hotkeys', {

beforeEach() {
this.clock = sinon.useFakeTimers();
this.player = TestHelpers.makePlayer();
},

afterEach() {
this.player.dispose();
this.clock.restore();
}
});

QUnit.test('when userActions.globalHotkeys is true, hotkeys are enabled at document.body level', function(assert) {
this.player.dispose();
this.player = TestHelpers.makePlayer({
controls: true,
userActions: {
globalHotkeys: true,
hotkeys: true
}
});

this.player.requestFullscreen = sinon.spy();

const event = new KeyboardEvent('keydown', { // eslint-disable-line no-undef
key: 'f'
});

document.body.dispatchEvent(event);

assert.strictEqual(this.player.requestFullscreen.callCount, 1, 'has gone fullscreen');
});

QUnit.test('when userActions.globalHotkeys is NOT true, hotkeys are NOT enabled at document.body level', function(assert) {
this.player.dispose();
this.player = TestHelpers.makePlayer({
controls: true,
userActions: {
globalHotkeys: false,
hotkeys: true
}
});

this.player.requestFullscreen = sinon.spy();

const event = new KeyboardEvent('keydown', { // eslint-disable-line no-undef
key: 'f'
});

document.body.dispatchEvent(event);

assert.strictEqual(this.player.requestFullscreen.callCount, 0, 'has not gone fullscreen');
});