As an open-source project, sindresorhus/screenfull has picked up 7.1k stars on GitHub (HTML). Simple wrapper for cross-browser usage of the JavaScript Fullscreen API
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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 ESM. Please familiarize yourself with what that implies.
If you cannot use ESM or need to support older browsers without using transpilation, use version 5.2.0.
Not supported on iPhone
This package is feature complete. No new features will be accepted.
Demo
Install
Only 0.7 kB gzipped.
npm install screenfull
Also available on cdnjs (older version).
Why?
Screenfull
import screenfull from 'screenfull';
if (screenfull.isEnabled) {
screenfull.request();
}
Vanilla JavaScript
document.fullscreenEnabled =
document.fullscreenEnabled ||
document.mozFullScreenEnabled ||
document.documentElement.webkitRequestFullScreen;
function requestFullscreen(element) {
if (element.requestFullscreen) {
element.requestFullscreen();
} else if (element.mozRequestFullScreen) {
element.mozRequestFullScreen();
} else if (element.webkitRequestFullScreen) {
element.webkitRequestFullScreen(Element.ALLOW_KEYBOARD_INPUT);
}
}
if (document.fullscreenEnabled) {
requestFullscreen(document.documentElement);
}
// This is not even entirely comprehensive. There's more.
Support
Supported browsers
Note: Safari is supported on desktop and iPad, but not on iPhone. This is a limitation in the browser, not in Screenfull.
Documentation
Examples
Fullscreen the page
import screenfull from 'screenfull';
document.getElementById('button').addEventListener('click', () => {
if (screenfull.isEnabled) {
screenfull.request();
} else {
// Ignore or do something else
}
});
Fullscreen an element
import screenfull from 'screenfull';
const element = document.getElementById('target');
document.getElementById('button').addEventListener('click', () => {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Hide navigation user-interface on mobile devices
import screenfull from 'screenfull';
const element = document.getElementById('target');
document.getElementById('button').addEventListener('click', () => {
if (screenfull.isEnabled) {
screenfull.request(element, {navigationUI: 'hide'});
}
});
Fullscreen an element with jQuery
import screenfull from 'screenfull';
const element = $('#target')[0]; // Get DOM element from jQuery collection
$('#button').on('click', () => {
if (screenfull.isEnabled) {
screenfull.request(element);
}
});
Toggle fullscreen on a image with jQuery
import screenfull from 'screenfull';
$('img').on('click', event => {
if (screenfull.isEnabled) {
screenfull.toggle(event.target);
}
});
Detect fullscreen change
import screenfull from 'screenfull';
if (screenfull.isEnabled) {
screenfull.on('change', () => {
console.log('Am I fullscreen?', screenfull.isFullscreen ? 'Yes' : 'No');
});
}
Remove listeners with:
import screenfull from 'screenfull';
screenfull.off('change', callback);
Detect fullscreen error
import screenfull from 'screenfull';
if (screenfull.isEnabled) {
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>
</div>
Fullscreen the page with Angular 2
import {Directive, HostListener} from '@angular/core';
import screenfull from 'screenfull';
@Directive({
selector: '[toggleFullscreen]'
})
export class ToggleFullscreenDirective {
@HostListener('click') onClick() {
if (screenfull.isEnabled) {
screenfull.toggle();
}
}
}
The default element is <html>. If called with another element than the currently active, it will switch to that if it's a descendant.
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.
Returns a promise that resolves after the element enters fullscreen.
.exit()
Brings you out of fullscreen.
Returns a promise that resolves after the element exits fullscreen.
.toggle(element, options?)
Requests fullscreen if not active, otherwise exits.
Accepts a DOM element and FullscreenOptions.
Returns a promise that resolves after the element enters/exits fullscreen.
.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.
.onchange(function)
Alias for .on('change', function)
.onerror(function)
Alias for .on('error', function)
.isFullscreen
Returns a boolean whether fullscreen is active.
.element
Returns the element currently in fullscreen, otherwise undefined.
.isEnabled
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
FAQ
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.
How active is development on sindresorhus/screenfull?
The most recent commit recorded on sindresorhus/screenfull was 2 months ago, based on the GitHub push timestamp. The repository has 680 forks — one of the better signals of community interest.
How many stars does sindresorhus/screenfull have?
sindresorhus/screenfull has 7.1k GitHub stars — refresh the page for the live number, or check github.com/sindresorhus/screenfull. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is sindresorhus/screenfull open source?
Yes — sindresorhus/screenfull ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/sindresorhus/screenfull.
What is sindresorhus/screenfull?
sindresorhus/screenfull (sindresorhus/screenfull) is a HTML project on GitHub. From the project's own README: Simple wrapper for cross-browser usage of the JavaScript Fullscreen API
What language is sindresorhus/screenfull written in?
sindresorhus/screenfull is written primarily in HTML. GitHub's language field is based on the largest share of bytes in the default branch.
What license does sindresorhus/screenfull use?
sindresorhus/screenfull is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about sindresorhus/screenfull?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/sindresorhus/screenfull is the definitive source.
Read full README in the tab above.
Is screenfull worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of screenfull.