Namespace: DOM

Utils for DOM

Source: index.js, line 14

Classes

KeyboardManager
MouseManager
Particles

Namespaces

Device

Members

(static, constant) exports.KeyboardManagerInstance

Source: KeyboardManager.js, line 222

(static, constant) exports.KEYS

Keys code for the keyboard

Source: KeyboardManager.js, line 7

(static, constant) exports.MouseButton

Mouse button keys

Source: MouseManager.js, line 7

(static, constant) exports.MouseManagerInstance

Source: MouseManager.js, line 226

Example

const { x, y } = MouseManagerInstance;
console.log(x, y);

(static, constant) exports.ParticlesInstance

Source: Particles.js, line 27

Methods

(static) deleteAllChildDom(domElement)

Eliminate all child elements of a choice parent element. For example: delete all dom

from a

Parameters:

Name	Type	Description
`domElement`	HTMLElement	The HTML element to exclude all children

Source: deleteAllChildDom.js, line 1

(static) exports.exportFile(data, filename, type) → {void}

Create a file and auto downloads the file to user computer

Parameters:

Name	Type	Description
`data`	any	the content to export
`filename`	string	the name of the exported file
`type`	string	type of the exported file like "txt"

Source: exportFile.js, line 10

Returns:

Type:: void

(static) getUrlParameter(key) → {string}

Get a value from a query parameter from the current URL

Parameters:

Name	Type	Description
`key`	string	The key of the query parameter

Source: getUrlParameter.js, line 1

Returns:

Returns the value of the key

Type:: string

Example

URL: http://localhost:8080/?name=Silva
getUrlParameter("name"); // Silva

(static) notification(options) → {void}

Display a pop up im the DOM with the given text

Example: https://codesandbox.io/s/201flaviosilva-utils-notification-g3nk0v

Parameters:

Name Type Description

options

Object

The options for the pop up

Properties

Name	Type	Description
`text`	string	display text in the pop up
`animated`	boolean	if the animation should be animated
`animationTime`	number	time for the animation
`closeButton`	boolean	if the pop up have the button to close or not
`endPosition`	number	position to stop the animation (top)
`style`	Object	the style for the wrapper
`textStyle`	Object	the style for the text (span)
`buttonStyle`	Object	the style for the close button
`parent`	HTMLElement	parent to create the pop up

Source: notification.js, line 28

Returns:

Type:: void

Examples

notification({ text: "notification" });

notification({
	text: "My nice text",
	animated: false,
	animationTime: 5,
	closeButton: true,
	endPosition: 250,
	style: { border: "10px solid rgb(0, 255, 100)", },
	textStyle: { textTransform: "uppercase", },
	buttonStyle: { backgroundColor: "red" },
});

(static) printObjectInDOM(object, parentopt)

Print JavaScript Object In HTML Dom

Parameters:

Name	Type	Attributes	Default	Description
`object`	Object			JavaScript Object to print in the dom
`parent`	HTMLElement	<optional>	document.body	DOM element to print

Source: printObjectInDOM.js, line 1
See: https://jsfiddle.net/201flaviosilva/mbnz3p7y/

Example

const myObject = {
	name: "Sistema Solar",
	numberStarts: 1,
	terra: {
		speed: 29.783,
		moons: ["Lua"],
		temperature: {
			min: 93.2,
			max: 57.8,
			average: 14,
		}
	},
};
printObjectInDOM(myObject, document.getElementById("myDomElement"));

(static) toggleFullScreen(element) → {void}

If a given element is not in full screen, starts the full-screen mode and focus on the element.
If the document is already in full screen mode, stop.

Parameters:

Name	Type	Description
`element`	HTMLElement	the DOM element to put in full screen

Source: toggleFullScreen.js, line 1

Returns:

Type:: void

Examples

toggleFullScreen();

toggleFullScreen(document.getElementById("myElement"));

```html
<!--- html --->
<button id="toggle">Toggle</button>
```

```js
// js
import { toggleFullScreen } from "201flaviosilva-utils";
document.getElementById("toggle").addEventListener("click", () => {
	toggleFullScreen(document.getElementById("toggle"));
});
```