Phaser.DOM
Scope: static
Source: src/dom/index.js#L7
Static functions
Static functions
AddToDOM
<static> AddToDOM(element, [parent])
Description:
Adds the given element to the DOM. If a parent is provided, the element is added as a child of the parent element, resolved either by passing a string ID to getElementById or by using the HTMLElement directly. If no parent is given and the element already has an existing parentElement, or if parent is explicitly null, the element is returned immediately without modification. If no valid target parent can be resolved, the element is appended to document.body as a fallback.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| element | HTMLElement | No | The element to be added to the DOM. Usually a Canvas object. |
| parent | string | HTMLElement | Yes | The parent in which to add the element. Can be a string which is passed to getElementById or an actual DOM object. |
Returns: HTMLElement - The element that was passed to this function.
Source: src/dom/AddToDOM.js#L7
Since: 3.0.0
CreateDOMContainer
<static> CreateDOMContainer(game)
Description:
Creates a DOM container div element for use with DOM Game Objects.
The container is an absolutely positioned div that overlays the game canvas, matching its dimensions, and is added to the game's parent element. It has pointer events set according to the game configuration and serves as the parent for any DOM Element Game Objects added to a Scene.
This function is called automatically during game boot if the game config has both a parent element and domCreateContainer set to true.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| game | Phaser.Game | No | The Phaser Game instance to create the DOM container for. |
Source: src/dom/CreateDOMContainer.js#L9
Since: 3.12.0
DOMContentLoaded
<static> DOMContentLoaded(callback)
Description:
Inspects the readyState of the document. If the document is already complete or interactive, it invokes the given callback immediately. If not, it registers event listeners to detect when the document becomes ready. On Cordova environments it listens for the deviceready event; otherwise it listens for DOMContentLoaded and the window load event, invoking the callback whichever fires first. If the document body is not yet available, it falls back to a short timeout before invoking the callback. Called automatically by the Phaser.Game instance. Should not usually be accessed directly.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| callback | ContentLoadedCallback | No | The callback to be invoked when the device is ready and the DOM content is loaded. |
Source: src/dom/DOMContentLoaded.js#L15
Since: 3.0.0
GetInnerHeight
<static> GetInnerHeight(iOS)
Description:
Attempts to determine the document inner height across iOS and standard devices. On non-iOS devices this simply returns window.innerHeight. On iOS, Safari's dynamic browser chrome (such as the address bar appearing or hiding on scroll) can cause window.innerHeight to report an inaccurate value. To work around this, a temporary fixed-position element sized to 100vh is injected into the DOM, its measured height is used instead, and the element is immediately removed. The result is also adjusted for landscape orientation using window.orientation. Based on code by @tylerjpeterson
Parameters:
| name | type | optional | description |
|---|---|---|---|
| iOS | boolean | No | Is this running on iOS? |
Returns: number - The inner height of the viewport, in pixels.
Source: src/dom/GetInnerHeight.js#L7
Since: 3.16.0
GetScreenOrientation
<static> GetScreenOrientation(width, height)
Description:
Attempts to determine the screen orientation using a series of browser APIs, falling back to comparing the viewport dimensions if none are available.
It checks, in order: the Screen Orientation API (screen.orientation, screen.mozOrientation, screen.msOrientation), the legacy window.orientation property (used on iOS), the window.matchMedia API, and finally a simple width-versus-height comparison as a last resort.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| width | number | No | The width of the viewport. |
| height | number | No | The height of the viewport. |
Returns: string - Either a Phaser.Scale.PORTRAIT or Phaser.Scale.LANDSCAPE string constant, or the raw orientation type string returned by the Screen Orientation API.
Source: src/dom/GetScreenOrientation.js#L9
Since: 3.16.0
GetTarget
<static> GetTarget(element)
Description:
Attempts to get the target DOM element based on the given value, which can be either a string, in which case it will be looked-up by ID, or an element node. If nothing can be found it will return a reference to the document.body.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| element | HTMLElement | No | The DOM element to look-up. Can be either a string, in which case it is used as an element ID to look up via document.getElementById, or a direct reference to an existing HTMLElement node. |
Returns: HTMLElement - The DOM element matching the given ID or node reference, or document.body if no valid target was found.
Source: src/dom/GetTarget.js#L7
Since: 3.16.0
ParseXML
<static> ParseXML(data)
Description:
Takes the given data string and parses it as XML. First tries to use the window.DOMParser and reverts to the Microsoft.XMLDOM if that fails. The parsed XML object is returned, or null if there was an error while parsing the data.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| data | string | No | The XML source stored in a string. |
Returns: XMLDocument - The parsed XML data, or null if the data could not be parsed.
Source: src/dom/ParseXML.js#L7
Since: 3.0.0
RemoveFromDOM
<static> RemoveFromDOM(element)
Description:
Attempts to remove the element from its parentNode in the DOM.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| element | HTMLElement | No | The DOM element to remove from its parent node. |
Source: src/dom/RemoveFromDOM.js#L7
Since: 3.0.0