phaser/src/dom/AddToDOM.js

53 lines
1.4 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
2020-01-15 12:07:09 +00:00
* @copyright 2020 Photon Storm Ltd.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2018-02-12 16:01:20 +00:00
*/
2017-10-12 14:09:52 +00:00
/**
2018-01-26 03:40:49 +00:00
* Adds the given element to the DOM. If a parent is provided the element is added as a child of the parent, providing it was able to access it.
2018-10-10 12:41:55 +00:00
* If no parent was given it falls back to using `document.body`.
2017-10-12 14:09:52 +00:00
*
2018-02-13 00:40:51 +00:00
* @function Phaser.DOM.AddToDOM
2017-10-12 14:09:52 +00:00
* @since 3.0.0
*
2018-03-19 15:29:26 +00:00
* @param {HTMLElement} element - The element to be added to the DOM. Usually a Canvas object.
2018-03-20 14:58:02 +00:00
* @param {(string|HTMLElement)} [parent] - The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.
2017-10-12 14:09:52 +00:00
*
2018-03-19 15:29:26 +00:00
* @return {HTMLElement} The element that was added to the DOM.
2017-10-12 14:09:52 +00:00
*/
var AddToDOM = function (element, parent)
{
var target;
if (parent)
{
if (typeof parent === 'string')
{
// Hopefully an element ID
target = document.getElementById(parent);
}
else if (typeof parent === 'object' && parent.nodeType === 1)
{
// Quick test for a HTMLElement
target = parent;
}
}
else if (element.parentElement)
{
return element;
}
// Fallback, covers an invalid ID and a non HTMLElement object
if (!target)
{
target = document.body;
}
target.appendChild(element);
return element;
};
module.exports = AddToDOM;