Simple wrapper for cross-browser usage of the JavaScript Fullscreen API
Clone or download
Latest commit 41d0b41 Sep 4, 2018


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 to.

This package is feature complete. No new changes will be accepted.

🔥 Want to strengthen your core JavaScript skills and master ES6?
I would personally recommend this awesome ES6 course by Wes Bos.


Check out my other projects


Only 0.7 kB gzipped.

Download the production version or the development version.

$ npm install --save screenfull

Also available on cdnjs.



if (screenfull.enabled) {

Vanilla JavaScript

document.fullscreenEnabled = document.fullscreenEnabled || document.mozFullScreenEnabled || document.documentElement.webkitRequestFullScreen;

function requestFullscreen(element) {
	if (element.requestFullscreen) {
	} else if (element.mozRequestFullScreen) {
	} else if (element.webkitRequestFullScreen) {

if (document.fullscreenEnabled) {

// Actually it's more if you want it to work in Safari, but let's not go there...


Supported browsers



Fullscreen the page

document.getElementById('button').addEventListener('click', () => {
	if (screenfull.enabled) {
	} else {
		// Ignore or do something else

Fullscreen an element

const el = document.getElementById('target');

document.getElementById('button').addEventListener('click', () => {
	if (screenfull.enabled) {

Fullscreen an element with jQuery

const target = $('#target')[0]; // Get DOM element from jQuery collection

$('#button').on('click', () => {
	if (screenfull.enabled) {

Toggle fullscreen on a image with jQuery

$('img').on('click', event => {
	if (screenfull.enabled) {

Detect fullscreen change

if (screenfull.enabled) {
	screenfull.on('change', () => {
		console.log('Am I fullscreen?', screenfull.isFullscreen ? 'Yes' : 'No');

Remove listeners with:'change', callback);

Detect fullscreen error

if (screenfull.enabled) {
	screenfull.on('error', event => {
		console.error('Failed to enable fullscreen', event);

See the demo for more examples, and view the source.

Fullscreen an element with Angular.js

You can use the Angular.js binding to do something like:

<div ngsf-fullscreen>
	<p>This is a fullscreen element</p>
	<button ngsf-toggle-fullscreen>Toggle fullscreen</button>

Fullscreen the page with Angular 2

import {Directive, HostListener} from '@angular/core';
import * as screenfull from 'screenfull';

	selector: '[toggleFullscreen]'
export class ToggleFullscreenDirective {
	@HostListener('click') onClick() {
		if (screenfull.enabled) {
<button toggleFullscreen>Toggle fullscreen<button>



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.


Brings you out of fullscreen.


Requests fullscreen if not active, otherwise exits.

.on(event, function)

Events: change error

Add a listener for when the browser switches in and out of fullscreen or when there is an error.

.off(event, function)

Remove a previously registered event listener.


Alias for .on('change', function)


Alias for .on('error', function)



Returns a boolean whether fullscreen is active.


Returns the element currently in fullscreen, otherwise null.


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).


Exposes the raw properties (prefixed if needed) used internally: requestFullscreen, exitFullscreen, fullscreenElement, fullscreenEnabled, fullscreenchange, fullscreenerror


How can I navigate to a new page when fullscreen?

That's not supported by browsers for security reasons. There is, however, a dirty workaround. Create a seamless iframe that fills the screen and navigate to the page in that instead.

$('#new-page-btn').click(() => {
	const iframe = document.createElement('iframe')

	iframe.setAttribute('id', 'external-iframe');
	iframe.setAttribute('src', '');
	iframe.setAttribute('frameborder', 'no'); = 'absolute'; = '0'; = '0'; = '0'; = '0'; = '100%'; = '100%';

	$(document.body).prepend(iframe); = 'hidden';



MIT © Sindre Sorhus