Fullscreen API

Written by David Walsh on December 23, 2013 · 43 Comments

As we move toward more true web applications, our JavaScript APIs are doing their best to keep up.  One very simple but useful new JavaScript API is the Fullscreen API.  The Fullscreen API provides a programmatic way to request fullscreen display from the user, and exit fullscreen when desired.  Here's how to use this incredibly simple API!

Launching Fullscreen Mode

The fullscreen API's requestFullscreen method is still prefixed in some browsers, so you'll need to do a bit of searching to find it:

// Find the right method, call on correct element
function launchFullscreen(element) {
  if(element.requestFullscreen) {
    element.requestFullscreen();
  } else if(element.mozRequestFullScreen) {
    element.mozRequestFullScreen();
  } else if(element.webkitRequestFullscreen) {
    element.webkitRequestFullscreen();
  } else if(element.msRequestFullscreen) {
    element.msRequestFullscreen();
  }
}

// Launch fullscreen for browsers that support it!
launchFullScreen(document.documentElement); // the whole page
launchFullScreen(document.getElementById("videoElement")); // any individual element

Simply call the request method on the element you'd like to receive fullscreen and the window morphs to fullscreen, requesting that the user allow fullscreen mode.  Remember it's plausible that the user will reject fullscreen mode.  If fullscreen mode is accepted, the toolbars and general chrome go away, making the document frame span the entire width and height of the screen.

Exiting Fullscreen Mode

The exitFullscreen method (also prefixed in older browsers) morphs the browser chrome back into standard layout:

// Whack fullscreen
function exitFullscreen() {
  if(document.exitFullscreen) {
    document.exitFullscreen();
  } else if(document.mozCancelFullScreen) {
    document.mozCancelFullScreen();
  } else if(document.webkitExitFullscreen) {
    document.webkitExitFullscreen();
  }
}

// Cancel fullscreen for browsers that support it!
exitFullscreen();

Note that exitFullscreen is called on the document object only -- not needing to pass the individual element itself.

Fullscreen Properties & Events

Unfortunately the events and properties are still prefixed, but will be unprefixed over time.

  • document.fullScreenElement: the element which has been pushed to fullscreen.
  • document.fullScreenEnabled:  notes if fullscreen is current enabled.

The fullscreenchange event lets us know when we go to/from fullscreen mode:

var fullscreenElement = document.fullscreenElement || document.mozFullScreenElement || document.webkitFullscreenElement;
var fullscreenEnabled = document.fullscreenEnabled || document.mozFullScreenEnabled || document.webkitFullscreenEnabled;

You can detect which browser-prefixed event to use along with the initial fullscreen method detection.

Fullscreen CSS

Browsers do provide us one helpful bit of fullscreen CSS control:

:-webkit-full-screen {
  /* properties */
}

:-moz-full-screen {
  /* properties */
}

:-ms-fullscreen {
  /* properties */
}

:full-screen { /*pre-spec */
  /* properties */
}

:fullscreen { /* spec */
  /* properties */
}

/* deeper elements */
:-webkit-full-screen video {
  width: 100%;
  height: 100%;
}

/* styling the backdrop*/
::backdrop {
  /* properties */
}
::-ms-backdrop {
  /* properties */
}

In some cases, WebKit needs a bit of help, so the code above should be kept handy if you're dealing with media.

The fullscreen API is super simple and super useful.  I first saw this API used with MDN's BananaBread demo, an all-client-side first person shooter, a perfect excuse to go fullscreen.  The fullscreen API provides a way to enter and exit fullscreen mode, as well as an event to detect fullscreen state change, so all bases are covered.  Keep this nice API in mind for your future ventures -- it may come in handy!

Comments

  1. I think the fullscreen API could be a great thing, if properly used. For instance, offering a full screen option accompanying an HTML5 video or slideshow element. As long as it’s accompanied by a similar exit fullscreen option that’s also readily available to the user.

    I’m afraid advertisers will use it as a way to automatically put the user into full screen mode with no option to exit.

  2. It works well in OS X. It uses the same full screen application UI as native applications, where you can revert it to being windowed by mousing over the top edge of the screen and clicking the button in the menu bar.

  3. in OSX, Chrome 22.

    document.fullScreenEnabled is: undefined

    • Correct, each browser doesn’t support each property yet, prefixed or not.

    • PM5544 April 5, 2013

      Hi Jinah and David,

      Ran into this myself and saw that Chrome uses the webkitFullscreenEnabled and webkitFullscreenElement and Firefox uses mozFullScreenEnabled and mozFullScreenElement.
      The difference is the casing of the “S” in “screen”.

    • PM5544 April 5, 2013

      I see that Almir posted this already :)

  4. This is very nice site for learn

  5. Is there any way to detect if full screen is enabled via css? Or are we forced to sniff in Javascript and set a className somewhere?

  6. Just one little correction:

    Google Chrome v.23 (actual) doesn’t implement webkitFullScreenElement and webkitFullScreenEnabled. It implements webkitFullscreenElement and webkitFullscreenEnabled (with lower case ‘S’). I can’t understand WHY they do that =P

  7. Is there any way to launch full screen on page load?
    something like:

    jQuery(document).ready(function(){
        //launch fullscreen code
    })
    
  8. Nedudi (Dmitry) January 31, 2013

    Hi, David!
    Nice article, just a small notice:

    var fullscreenElement = document.fullScreenElement || document.mozFullScreenElement || document.webkitFullScreenElement;
    var fullscreenEnabled = document.fullScreenEnabled || document.mozScreenEnabled || document.webkitScreenEnabled;

    is wrong :)
    please change with:

    var fullscreenElement = document.fullscreenElement || document.mozFullscreenElement || document.webkitFullscreenElement;
    var fullscreenEnabled = document.fullscreenEnabled || document.mozFullscreenEnabled || document.webkitFullscreenEnabled;

    thanks ;)

  9. Hello, How can i make it possible page onload ?

    • Add an onload listener? You have to seek user permission at some point though.

    • I am not getting the way to use this onload.. do anyone have sample code… thx in advance

  10. Hey David

    I am facing an issue that while Full Screen Mode is ON then if i will press down ESC key then next time for Full Screen I need click couple of times at Full screen Button and in another case If i will get down exit from Full screen Mode without Pressing ESC key then it will work properly in a single click.

    please suggest me or give me way out.

    • Hi Guys

      I found Solution of my Problem

      We just need to add below line in existing Code

        document.getElementById('enter-exit-fs').onclick = enterFullscreen;
      
      //Old Code
      // Called whenever the browser exits fullscreen.
      function onFullScreenExit() {
        console.log("Exited fullscreen!");
      };
      
      //New  Code Will be
      // Called whenever the browser exits fullscreen.
      function onFullScreenExit() {
        console.log("Exited fullscreen!");
        document.getElementById('enter-exit-fs').onclick = enterFullscreen;
      };
      
  11. Clement Yap March 21, 2013

    When using, , what should the correct for the document, if not from the same page? ie; open the page for the first time in the full screen.

  12. Clement Yap March 21, 2013

    I mean When using “body tag… onload=”launchFullscreen(document.documentElement) …/ body tag”

  13. Hi ,

    I am developing a new website, in which am expanding the size of my video using webkitrequestfullscreen, so while closing the full screen, i have to resize the video to my previous size. if i perform this using fullscreen button on my website, its working properly, but if i use the popup coming on top of the browser to close the full screen, my video is not getting resized. please guide me, what should i do.?

  14. I use chrome 26 for testing my software. I built in this fullscreen api. When the document is in fullscreen, it seems to be inactive: it does not get any keyboard event, even the input fields do not work.

  15. $('html').on('click keypress', 'a', function(event) {
    
      // Prevent navigation to legit link
      event.preventDefault();
      event.stopPropagation();
    
      // Trigger fullscreen
      if (elementPrototype.requestFullscreen) {
        document.documentElement.requestFullscreen();
      } else if (elementPrototype.webkitRequestFullScreen) {
        document.documentElement.webkitRequestFullScreen(Element.ALLOW_KEYBOARD_INPUT);
      } else if (elementPrototype.mozRequestFullScreen) {
        document.documentElement.mozRequestFullScreen();
      } else {
        // fail silently
      }
    
      // Show fake OS and browser UI
      $('#menu, #browser').show();
    
      // Show fake target site
      $('#target-site').show();
    });
    
  16. If you have any idea about disable esc button using javascript

  17. I find it difficult to use html code above him can you help me. I am still a newbie.

  18. Is there a way to hold the fullscreen when changing pages? Like how the browser functions when using keyboard shortcuts?

  19. i can’t call the request method on the element to receive fullscreen and the window morphs to fullscreen. can you help me. i am a still newbie.

  20. Clement Yap August 15, 2013

    Hi I am successful using FF Full Screen API. Also I am able to make changes to button whenever I toggle the screen. However, I am not able to make changes to looks, whenever I pressed ESC. I tried implementing keyup event but it does not work. I am using dojo.

    var toggled = true;
        						function toggle()
    								{
        								toggled ? launchFullscreen(document.documentElement) : cancelFullscreen();
        								btnFS.set("iconClass", toggled ? "icon_FSsmall" : "icon_FSlarge");
        								btnFS.set("label", toggled ? "Reset to Normal Screen" : "Set to Full Screen");
        								toggled = !toggled;
        								console.debug(toggled);
    								}
    			
    							var btnFS = new Button
    								({
    									label:"Set to Full Screen",
    									iconClass:'icon_FSlarge',
    									onClick:function()
    										{
    											toggle();
    										}
    								}, "node_btnFS")
    							btnFS.startup();
    
    
    
    on(document,"keyup", function(event)
        						{	
    								console.debug(toggled);
    								if (event.keyCode = 27)
    								{
    									btnFS.set("iconClass", "icon_FSlarge");
        								btnFS.set("label", "Set to Full Screen");
    								}
    							});
    
    

    Pls advise
    Thanks
    Clement

  21. Does this work if my div tag displays DOJO table? I am not able to get full screen for it.

  22. If the user selects “remember decision” at the fullscreen prompt, is there any way to access this setting?

    On subsequent page load:
    If they had selected Block (and remember), then I do not want to force them to see the prompt.

  23. Hi David,

    Excellent ! I spent at least 3 hours to refer Fullscreen API documents but i got confused, I couldn’t create a Fullscreen button to work on my Joomla website. But, i had a nice day with your guides and your codes. Wow ! I’m really excited now !

  24. can you please create a workable downloadable script of your demo for users?

  25. Hello !

    is it possible to use with a wordpress website ?

    thankyou !

  26. *claps* I this is very creative and works very well on my mac.

  27. Hi David,

    I just tried this, but there is an issue, maybe you know of it.

    It seems it’s only possible to do this via an onclick event? e.g. I cannot just run launchFullScreen(document.documentElement); in my console or in some code callback code.

    Regards,

    Frodo

  28. Actually I looked into the fullscreen API a while ago and stumbled upon this https://github.com/sindresorhus/screenfull.js
    I’m using it for a couple weeks in production, and it seems to work well so far..

  29. NicholasBG January 11, 2014

    This css…

    :-moz-fullscreen

    doesn’t work and should be this…

    :-moz-full-screen

    Also your FF full screen demo works to go into full screen mode but not to get out of it.

  30. Need help to use the fulscreen at document load or document ready etc.

    I see this working only with onclick event binded.

    Thanks in advance , Pls comment with sugestions and Help .

  31. This works great, but text input is disabled… How do you enable it?

  32. Hi David, will this possible to use it on blogspot blog? I would like to have this on my blog..

Be Heard

Tip: Wrap your code in <pre> tags or link to a GitHub Gist!

Use Code Editor
Older
Reset a Branch to Remote State with git
Newer
Cross Domain Canvas Images