Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A plugin for using the browser's Full Screen API

branch: master
readme.md

jQuery FullScreen Plugin

A jQuery 1.7 plugin that wraps around the Full Screen API and works around various browser differences. Works in FF 10, Chrome and Safari. It is useful for presenting users with an easier to read version of your web pages, or zooming <canvas> and <video> elements.

How to use

Include jquery.fullscreen.js in your page along with version 1.7 of the jQuery library. This gives you the $('#elem').fullScreen() method. You can optionally pass an object with properties:

Property Value Meaning
background a color hash This is the color that will be used for the background.
callback a function The callback function will be called on a full screen change event. It has one argument - a boolean indicating whether we are in full screen or not.
fullscreenClass a string This is the CSS class that will be added to elements in fullscreen mode. The default class is "fullScreen".

After the plugin makes your element full screen, it will add the fullScreen class on it (unless overridden with the fullscreenClass parameter), so you can easily style it.

Example

// The plugin sets the $.support.fullscreen flag:
if($.support.fullscreen){

    // ...
    // Show your full screen button here
    // ...

    $('#fullScreen').click(function(e){

        $('#content').fullScreen();

        // You can also pass a hash with properties:
        // $('#content').fullScreen({
        //  'background'    : '#111',
        //  'callback'      : function(isFullScreen){
        //      // ...
        //      // Do some cleaning up here
        //      // ...
        //  }
        // });
    });
}

You can then apply additional styles to your element. Take the opportunity to increase the font size, hide distractions and make for a better reading experience.

#content.fullScreen{
    /* Give the element a width and margin:0 auto; to center it. */
}

If you later wish to cancel the full screen view, you can do so by calling the fullScreen() method again.

Demo

Go to Tutorialzine for a live demo.

Something went wrong with that request. Please try again.