Changes

Jump to: navigation, search

Gecko:FullScreenAPI

989 bytes removed, 23:48, 11 April 2011
no edit summary
== Requirements ==
* Scripts should be able to initiate and terminate fullscreenfull-screen** Allows custom, in-page, discoverable UI to active fullscreenfull-screen* Arbitrary Web content should be visible fullscreenfull-screen
** <video>, <canvas>, multicolumn text, etc
** Required for scripted video controls
* Entering and exiting fullscreen full-screen must trigger events
** To allow scripted changes to content, e.g. resizing of canvas content
* Scripts should be able to opt in to having alphanumeric keyboard input disabled during fullscreenfull-screen
** Enables less restrictive anti-spoofing measures
* Actual fullscreen full-screen transitions must be allowed to be asynchronous and entirely at the discretion of the UA
** To enable passive notification/confirmation UI
** To enable a wide range of security measures to prevent spoofing or other abuse
* Making a single element fullscreen full-screen should be as simple as possible
* Content in IFRAMEs should be able go fullscreenfull-screen** To enable "widgets" such as embedded videos to offer fullscreen full-screen UI
== Proposed Specification ==
A Document can be in the "fullscreen full-screen state". What exactly this means is up to the UA, but typically it means that the Document covers most or all of the screen and some or all of the normal UA UI is not visible.
It is possible for non-toplevel browsing contexts to have their Document in the fullscreen full-screen state. The parent browsing context of a browsing context with its Document in the fullscreen full-screen state must also have its Document in the fullscreen full-screen state.
The user agent may transition a Document into or out of the fullscreen full-screen state at any time, whether or not script has requested it. User agents are encouraged to provide standard UI to exit the fullscreen full-screen state, for example if the user presses the Escape key.
Toplevel browsing contexts can be in a "keys disabled" state. In this state,
* DOM_VK_SEMICOLON to DOM_VK_EQUALS, inclusive
* DOM_VK_MULTIPLY to DOM_VK_META, inclusive
Such events are not dispatched to any nodes in any document of the toplevel browsing context or descendant browsing contexts. This includes suppression of any internal key event processing that would insert text into form controls or editable content. The user agent might respond to such events by leaving fullscreen full-screen mode.
Each document has an optional "current fullscreen full-screen element".
New method of Document:
* void cancelFullScreen()
Requests that the UA exit fullscreen full-screen mode. The UA is not required to honor this, for example the UA might require that only a Document that last triggered fullscreen full-screen can cancel it.
The current fullscreen full-screen element for the document is cleared.
New methods of Element:
* void requestFullScreenWithKeys()
The current fullscreen full-screen element for the document is set to this element.
Typically the user agent would react by transitioning the Document to the fullscreen full-screen state, or by presenting asynchronous confirmation UI and transitioning to the fullscreen full-screen state if/when the user responds affirmatively. However, the user agent is not required to do anything at all in response to requestFullScreen. The user agent's behavior is allowed to vary depending on whether requestFullScreen is called during a user event (e.g. a mouse click handler).
* void requestFullScreen()
As requestFullScreenWithKeys, but hints to the UA that while in fullscreen full-screen state, the toplevel browsing context for this Document should have keys disabled. While keys are disabled, there may be a reduced risk of spoofing attacks inducing the user to input inappropriate data, and the UA may choose to relax restrictions on entering fullscreen full-screen state with keys disabled.
New DOM attribute of Document:
* readonly attribute boolean fullScreen
Returns true while the document is in the fullscreen full-screen state.
* readonly attribute boolean fullScreenKeyboardInputAllowed
Returns true while the window's toplevel browsing context is fullscreen full-screen and not in a "keys disabled" state.
New content attribute of the <iframe> element:
* allowfullscreen
This is a boolean attribute. When this attribute is not set, UAs must ignore fullscreen full-screen requests in the iframe or its descendant frames.
New events:
* fullscreenchange
When a Document enters or leaves the fullscreen full-screen state, the user agent must queue a task to dispatch this event. When the event is dispatched, if the document's current fullscreen full-screen element is an element in the document, then the event target is that element, otherwise the event target is the document. The event bubbles and is not cancellable.
The 'onfullscreenchange' event handling attribute is supported on HTML elements.
* :full-screen
While a Document is in the fullscreen full-screen state, and the document's current fullscreen full-screen element is an element in the document, the 'full-screen' pseudoclass applies to that element. Also, an <iframe>, <object> or <embed> element whose child browsing context's Document is in the fullscreen full-screen state has the 'full-screen' pseudoclass applied.
New CSS media query selector:
* <code>off</code>
While a Document is in the fullscreen full-screen state, the fullscreen full-screen media type is active for the document.
Suggested UA stylesheet rules:
/* A fullscreen full-screen element that is not the root element should be stretched
to cover the viewport. */
:full-screen:not(:root) {
background:black;
}
/* In fullscreen full-screen mode, if the root element itself is not fullscreen full-screen then
we should hide the viewport scrollbar. */
@media all and (full-screen:on) {
The specification intentionally gives UAs great freedom in policy, because no one policy can fit all users, devices, and user interface designs. However, here is a policy that should be acceptable for conventional desktop browsers.
* requestFullScreen while the window is already in the fullscreen full-screen state is approved.
* Otherwise, requestFullScreen outside a user action (e.g. a non-synthesized input event handler) is denied.
* Otherwise, requestFullScreen without the ALLOW_KEYBOARD_INPUT flag is approved.
== Implications ==
There is no requirement to exit fullscreen full-screen state when a browsing context is navigated to a new page.
There is no requirement to exit fullscreen full-screen state if the current fullscreen full-screen element shifts to another element, or ceases to be an element in the document (e.g. because requestFullScreen was called again in the document or in some descendant document, or because the element is removed).
Nothing in this specification depends on whether the current fullscreen full-screen element is visible (e.g. whether it has "display:none").
Nothing in this specification affects or depends on focus.
== Examples ==
1. Make a video element display fullscreen full-screen when clicked and leave fullscreen full-screen when it ends.
&lt;video src="pelican.webm" autoplay
&lt;/video&gt;
2. Make a canvas element display fullscreen full-screen in response to user input. Resize the canvas to the appropriate resolution while it's fullscreenfull-screen.
&lt;script&gt;
&lt;/button&gt;
3. Hide advertisements while the window is fullscreenfull-screen.
@media all and (full-screen:on) {
** the Firefox 4 "View" menu item "Full Screen" (shift-command-F)
 Whichever we pick, we should be consistent, e.g., EITHER: 1. one word* '''fullscreen'''** roc:fullscreen** media query selector feature: fullscreen** cancelFullscreen()** requestFullscreen()** requestFullscreenWithKeys() OR 2. two words* '''full screenElika and I resolved to use '''** :full-screen** media query selector feature: full-screen** cancelFullScreen()** requestFullScreen()** requestFullScreenWithKeys() OR  3. come up with a good case (e.g. CSS vs DOM) to split them consistently:* '''full screen'''** :fullscreen** media query selector feature: fullscreen** cancelFullScreen()** requestFullScreen()** requestFullScreenWithKeys()  === media type vs media query selector === <code>@media full-screen</code> vseverywhere. <code>@media all and (full-screen: on)</code> Originally spec'd: New CSS media type: * full-screen While a Document is in the fullscreen state, the full-screen media type is active for the document.  Per discussion among [[User:Fantasai]], [[User:Roc]], [[User:Tantek]] a media query selector for the fullscreen state (on or off) may be better, e.g. it can be combined with all media types: <code>@media all and (full-screen: on)</code> or can be special cased for specific media types: <code>@media handheld and (full-screen: on)</code> <code>@media screen and (full-screen: on)</code> <code>@media tv and (full-screen: on)</code> If we resolve the naming issue based on one word rather than two, then we'll rename this CSS feature accordingly ( :fullscreen , media query selector "fullscreen" )
=== avoiding ancestor reflow ===
The underlying background of this new opaque CSS canvas comes from the fullscreened element, just as the underlying background of a window comes from the root element of the document in that window.
 
''roc: I don't want to do it this way. Creating additional views is very difficult to fit into the architecture of Gecko and other engines. The existing way seems fine in practice. Reflowing the document is not going to be a significant performance issue.''
=== avoiding drawing anything else ===
Also, the suggested UA stylesheet rules use z-index to put the fullscreened element above everything else. Instead we may want to specify that when something is fullscreened, that we don't bother rendering any other windows/tabs, nor the parent document.
 
''roc: Again this is more invasive to the engine than necessary. The z-index approach should work fine and is simple, without requiring any special engine support.''
1,295
edits

Navigation menu