You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Simple wrapper for cross-browser usage of the JavaScript Fullscreen API, which lets you bring the page or any element into fullscreen. Smoothens out the browser implementation differences, so you don't have too.
document.fullscreenEnabled=document.fullscreenEnabled||document.mozFullScreenEnabled||document.documentElement.webkitRequestFullScreen;functionrequestFullscreen(element){if(element.requestFullscreen){element.requestFullscreen();}elseif(element.mozRequestFullScreen){element.mozRequestFullScreen();}elseif(element.webkitRequestFullScreen){element.webkitRequestFullScreen(Element.ALLOW_KEYBOARD_INPUT);}}if(document.fullscreenEnabled){requestFullscreen(document.documentElement);}// Actually it's more if you want it to work in Safari, but let's not go there...
Safari doesn't support use of the keyboard in fullscreen.
Documentation
Examples
Fullscreen the page
document.getElementById('button').addEventListener('click',function(){if(screenfull.enabled){screenfull.request();}else{// Ignore or do something else}});
vartarget=$('#target')[0];// Get DOM element from jQuery collection$('#button').click(function(){if(screenfull.enabled){screenfull.request(target);}});
Toggle fullscreen on a image with jQuery
$('img').click(function(){if(screenfull.enabled){// We can use `this` since we want the clicked elementscreenfull.toggle(this);}});
Detect fullscreen change
if(screenfull.enabled){document.addEventListener(screenfull.raw.fullscreenchange,function(){console.log('Am I fullscreen? '+(screenfull.isFullscreen ? 'Yes' : 'No'));});}
Detect fullscreen error
if(screenfull.enabled){document.addEventListener(screenfull.raw.fullscreenerror,function(event){console.error('Failed to enable fullscreen',event);});}
See the demo for more examples, and view the source.
Methods
.request()
Make an element fullscreen.
Accepts a DOM element. Default is <html>. If called with another element than the currently active, it will switch to that if it's a decendant.
If your page is inside an <iframe> you will need to add a allowfullscreen attribute (+ webkitallowfullscreen and mozallowfullscreen).
Keep in mind that the browser will only enter fullscreen when initiated by user events like click, touch, key.
.exit()
Brings you out of fullscreen.
.toggle()
Requests fullscreen if not active, otherwise exits.
Properties
.isFullscreen
Returns a boolean whether fullscreen is active.
.element
Returns the element currently in fullscreen, otherwise null.
.enabled
Returns a boolean whether you are allowed to enter fullscreen. If your page is inside an <iframe> you will need to add a allowfullscreen attribute (+ webkitallowfullscreen and mozallowfullscreen).
.raw
Exposes the raw properties (prefixed if needed) used internally: requestFullscreen, exitFullscreen, fullscreenElement, fullscreenEnabled, fullscreenchange, fullscreenerror