sindresorhus/screenfull
Screenfull
Screenfull is a lightweight JavaScript utility that wraps the browser's Fullscreen API into a single, consistent interface. It normalizes the vendor-prefixed fullscreen methods across different browsers, providing a unified way to request, exit, and toggle fullscreen mode on any DOM element or the entire page.
The library handles cross-browser differences automatically, abstracting away the webkit, moz, and ms prefixes behind a clean API. It includes runtime feature detection to check browser support before exposing fullscreen methods, and uses promises for asynchronous fullscreen requests and exits, enabling straightforward error handling and chaining. Screenfull also provides event-driven state tracking, listening to native fullscreenchange and fullscreenerror events to maintain accurate internal state and fire callbacks when fullscreen mode is entered, exited, or fails.
Beyond the core request and exit functions, Screenfull offers a toggle method that automatically determines whether to enter or exit fullscreen based on the current state. It includes utilities for querying the current fullscreen element, checking whether fullscreen is active, and attaching or removing event listeners for change and error events. The library also provides a fullscreen availability check that considers iframe permissions, helping developers avoid runtime errors when fullscreen is not permitted.
Features
- Fullscreen API Wrappers - The core purpose of the library: a cross-browser wrapper for the Fullscreen API.
- Fullscreen State Trackers - Listens to native fullscreen events to maintain accurate internal state.
- Fullscreen State Toggles - Provides a single toggle method that automatically enters or exits fullscreen.
- Browser API Normalizers - Normalizes browser-specific Fullscreen API methods into a single consistent interface.
- Fullscreen Target Mapping - Allows requesting fullscreen on a specific DOM element or the entire document.
- Fullscreen Feature Detectors - Checks browser support for fullscreen methods before exposing them.
- Fullscreen Management - Provides a unified API to detect whether the document is currently in fullscreen mode.
- Native Fullscreen Toggles - Provides a toggle method that automatically enters or exits native fullscreen mode.
- Fullscreen Entry Request - Requests fullscreen for a specific DOM element or the whole page, returning a promise.
- Fullscreen Exit Request - Exits fullscreen mode and returns to normal view, resolving a promise when done.
- Fullscreen Toggle Requests - Ships a toggle method that returns a promise when fullscreen mode changes.
- Fullscreen Toggle Utilities - Provides a toggle utility that automatically determines whether to enter or exit fullscreen.
- Fullscreen Mode Togglers - Switches a page or element into fullscreen mode using a consistent cross-browser wrapper.
- Vendor Prefix Normalizers - Normalizes vendor-prefixed fullscreen method names across browsers into a unified API.
- Fullscreen Event Attachers - Attaches callbacks for fullscreen entry, exit, and error events.
- Promise-Based Chains - Wraps fullscreen requests and exits in promises for chaining and error handling.
- Fullscreen Event Listeners - Provides cross-browser event listener attachment for fullscreen state changes and errors.
- Fullscreen Change Callbacks - Fires a callback whenever the fullscreen state changes.
- Fullscreen Event Detachers - Detaches previously registered callbacks from fullscreen change or error events.
- Fullscreen Event Subscribers - Subscribes to fullscreen change and error events for reactive behavior.
- Fullscreen Permission Checkers - Checks whether the browser permits entering fullscreen mode, considering iframe permissions.
- Fullscreen Support Detectors - Provides a function to check fullscreen availability, considering iframe permissions.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
