Điểm qua sindresorhus/screenfull: 7.1k sao trên GitHub, viết chủ yếu bằng HTML. Simple wrapper for cross-browser usage of the JavaScript Fullscreen API
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
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.
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/sindresorhus/screenfull là nguồn chính thức.
sindresorhus/screenfull có bao nhiêu sao?
sindresorhus/screenfull có 7.1k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/sindresorhus/screenfull. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
sindresorhus/screenfull có phải mã nguồn mở không?
Có — sindresorhus/screenfull phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/sindresorhus/screenfull.
sindresorhus/screenfull còn đang phát triển không?
Commit gần nhất trên sindresorhus/screenfull là 2 tháng trước (theo timestamp GitHub). Repo có 680 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
sindresorhus/screenfull dùng license gì?
sindresorhus/screenfull phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
sindresorhus/screenfull là gì?
sindresorhus/screenfull (sindresorhus/screenfull) là dự án HTML trên GitHub. Theo mô tả gốc: Simple wrapper for cross-browser usage of the JavaScript Fullscreen API
sindresorhus/screenfull viết bằng ngôn ngữ gì?
sindresorhus/screenfull chủ yếu viết bằng HTML. Trường "language" của GitHub dựa trên phần lớn byte ở nhánh mặc định.
Đọc đầy đủ README ở tab phía trên.
screenfull có đáng để bạn bỏ thời gian?
ChatGPT, Claude và Perplexity đều đọc được trang này. Hỏi thử xem họ nghĩ gì về screenfull.