fullscreen.spec.whatwg.orgFullscreen API Standard

Fullscreen API Living Standard — Last Updated 7 May 2024 Participate: GitHub whatwg/fullscreen ( new issue , open issues ) Chat on Matrix Commits: GitHub whatwg/fullscreen/commits Snapshot as of this commit @fullscreenapi Tests: web-platform-tests fullscreen/ ( ongoing work ) Translations (non-normative) : 日本語 Abstract The Fullscreen API standard defines an API for elements to display themselves fullscreen. Table of Contents 1 Terminology 2 Model 3 API 4 UI 5 Rendering 5.1 :fullscreen pseudo-class 5.2 User-agent level style sheet defaults 6 Permissions Policy Integration 7 Security and Privacy Considerations Previously-hosted definitions Acknowledgments Intellectual property rights Index Terms defined by this specification Terms defined by reference References Normative References IDL Index 1. Terminology This specification depends on the Infra Standard. [INFRA] Most terminology used in this specification is from CSS, DOM, HTML, and Web IDL. [CSS] [DOM] [HTML] [WEBIDL] 2. Model All elements have an associated fullscreen flag . Unless stated otherwise it is unset. All iframe elements have an associated iframe fullscreen flag . Unless stated otherwise it is unset. All documents have an associated fullscreen element . The fullscreen element is the topmost element in the document ’s top layer whose fullscreen flag is set, if any, and null otherwise. All documents have an associated list of pending fullscreen events , which is an ordered set of ( string , element ) tuples . It is initially empty. To fullscreen an element : Let hideUntil be the result of running topmost popover ancestor given element , null, and false. If hideUntil is null, then set hideUntil to element ’s node document . Run hide all popovers until given hideUntil , false, and true. Set element ’s fullscreen flag . Remove from the top layer immediately given element . Add to the top layer given element . To unfullscreen an element , unset element ’s fullscreen flag and iframe fullscreen flag (if any), and remove from the top layer immediately given element . To unfullscreen a document , unfullscreen all elements , within document ’s top layer , whose fullscreen flag is set. To fully exit fullscreen a document document , run these steps: If document ’s fullscreen element is null, terminate these steps. Unfullscreen elements whose fullscreen flag is set, within document ’s top layer , except for document ’s fullscreen element . Exit fullscreen document . Whenever the removing steps run with a removedNode , run these steps: Let document be removedNode ’s node document . Let nodes be removedNode ’s shadow-including inclusive descendants that have their fullscreen flag set, in shadow-including tree order . For each node in nodes : If node is document ’s fullscreen element , exit fullscreen document . Otherwise, unfullscreen node . If document ’s top layer contains node , remove from the top layer immediately given node . Other specifications can add and remove elements from top layer , so node might not be document ’s fullscreen element . For example, node could be an open dialog element. Whenever the unloading document cleanup steps run with a document , fully exit fullscreen document . Fullscreen is supported if there is no previously-established user preference, security risk, or platform limitation. To run the fullscreen steps for a document document , run these steps: Let pendingEvents be document ’s list of pending fullscreen events . Empty document ’s list of pending fullscreen events . For each ( type , element ) in pendingEvents : Let target be element if element is connected and its node document is document , and otherwise let target be document . Fire an event named type , with its bubbles and composed attributes set to true, at target . These steps integrate with the event loop defined in HTML. [HTML] 3. API enum FullscreenNavigationUI { "auto" , "show" , "hide" }; dictionary FullscreenOptions { FullscreenNavigationUI navigationUI = "auto"; }; partial interface Element { PromiseundefinedrequestFullscreen ( optional FullscreenOptions options = {}); attribute EventHandler onfullscreenchange ; attribute EventHandler onfullscreenerror ; }; partial interface Document { [ LegacyLenientSetter ] readonly attribute boolean fullscreenEnabled ; [ LegacyLenientSetter , Unscopable ] readonly attribute boolean fullscreen ; // historical PromiseundefinedexitFullscreen (); attribute EventHandler onfullscreenchange ; attribute EventHandler onfullscreenerror ; }; partial interface mixin DocumentOrShadowRoot { [ LegacyLenientSetter ] readonly attribute Element ? fullscreenElement ; }; promise = element . requestFullscreen([ options ]) Displays element fullscreen and resolves promise when done. When supplied, options ’s navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to " show ", navigation simplicity is preferred over screen space, and if set to " hide ", more screen space is preferred. User agents are always free to honor user preference over the application’s. The default value " auto " indicates no application preference. document . fullscreenEnabled Returns true if document has the ability to display elements fullscreen and fullscreen is supported , or false otherwise. promise = document . exitFullscreen() Stops document ’s fullscreen element from being displayed fullscreen and resolves promise when done. document . fullscreenElement Returns document ’s fullscreen element . shadowroot . fullscreenElement Returns shadowroot ’s fullscreen element . A fullscreen element ready check for an element element returns true if all of the following are true, and false otherwise: element is connected . element ’s node document is allowed to use the " fullscreen " feature. element namespace is not the HTML namespace or element ’s popover visibility state is hidden . The requestFullscreen( options ) method steps are: Let pendingDoc be this ’s node document . Let promise be a new promise. If pendingDoc is not fully active , then reject promise with a TypeError exception and return promise . Let error be false. If any of the following conditions are false, then set error to true: This ’s namespace is the HTML namespace or this is an SVG svg or MathML math element. [SVG] [MATHML] This is not a dialog element. The fullscreen element ready check for this returns true. Fullscreen is supported . This ’s relevant global object has transient activation or the algorithm is triggered by a user generated orientation change . If error is false, then consume user activation given pendingDoc ’s relevant global object . Return promise , and run the remaining steps in parallel . If error is false, then resize pendingDoc ’s node navigable ’s top-level traversable ’s active document ’s viewport’s dimensions, optionally taking into account options [" navigationUI "]: value viewport dimensions " hide " full dimensions of the screen of the output device " show " dimensions of the screen of the output device clamped to allow the user agent to show page navigation controls " auto " user-agent defined, but matching one of the above Optionally display a message how the end user can revert this. If any of the following conditions are false, then set error to true: This ’s node document is pendingDoc . The fullscreen element ready check for this returns true. If error is true: Append ( fullscreenerror , this ) to pendingDoc ’s list of pending fullscreen events . Reject promise with a TypeError exception and terminate these steps. Let fullscreenElements be an ordered set initially consisting of this . While true: Let last be the last item of fullscreenElements . Let container be last ’s node navigable ’s container . If container is null, then break . Append container to fullscreenElements . For each element in fullscreenElements : Let doc be element ’s node document . If element is doc ’s fullscreen element , continue . No need to notify observers when nothing has changed....