JSDoc: Namespace:

SpacerJS, finds/creates an element

Parameters:

Name	Type	Attributes	Description
`selector`	string \| HTMLElement		A valid selector
`create`	boolean	<optional>	Boolean to create an element or not
`contents`	string	<optional>	Contents to find element by
`strict`	boolean	<optional>	If true, the contents must match the text exactly

License:

Source:

Spacer.js, line 44

Members

(inner) element

The selected HTMLElement

Source:

Spacer.js, line 48

(inner) fn

Object of any custom methods you want to add

Source:

Spacer.js, line 71

(inner) meta

Meta data object

Source:

Spacer.js, line 56

(inner) nodelist

The selected nodelist

Source:

Spacer.js, line 52

(inner) state

Object that keeps track of element's meta state

Properties:

Name	Type	Description
`hidden`	boolean	Tracks if element is hidden by hide() or show() meta functions
`hovered`	boolean	Tracks if element is hovered by hover() or unhover() meta functions
`active`	boolean	Tracks if element is active by active() or unactive() meta functions

Source:

Spacer.js, line 63

Methods

(inner) __(selector)

Selects and returns a NodeList

Parameters:

Name	Type	Description
`selector`	string	QuerySelectorAll string

Source:

Spacer.js, line 167

(inner) active()

Adds the activeClass that was set with setMeta(metaObj)

Source:

Spacer.js, line 514

(inner) addClass(className)

Adds a class to the element

Parameters:

Name	Type	Description
`className`	string	Class Name

Source:

Spacer.js, line 444

(inner) animate(cssProperty, value, time)

Animates the element

Parameters:

Name	Type	Description
`cssProperty`	string	cssProperty to edit
`value`	string	New value of cssProperty
`time`	string	Css Transition length, ex: "1s"

Source:

Spacer.js, line 686

(inner) append(elem)

Appends the a Node or string to a parent element

Parameters:

Name	Type	Description
`elem`	HTMLElement \| Node \| String	Selector string or HTMLElement

Source:

Spacer.js, line 192

(inner) appendChild(child)

Appends a child element

Parameters:

Name	Type	Description
`child`	HTMLElement	An HTMLElement

Source:

Spacer.js, line 200

(inner) appendList(elementlist)

Appends a list of HTML Elements

Parameters:

Name	Type	Description
`elementlist`	Array.<HTMLElement>	Array of Elements or nodes

Source:

Spacer.js, line 208

(inner) appendTo(parent)

Appends the child element to a parent element

Parameters:

Name	Type	Description
`parent`	string \| HTMLElement	Selector string

Source:

Spacer.js, line 176

(inner) at(index)

Selects an element, not 0 based

Parameters:

Name	Type	Description
`index`	number	Index

Source:

Spacer.js, line 595

Returns:

Element | undefined

Example

let myElement = _('div').at(5) // gets the fifth child and not the 4th like an array

(inner) attr(attribute, value)

Sets/Creates a attribute to a value

Parameters:

Name	Type	Description
`attribute`	string	Attribute to set/create
`value`	string	Value that the Attribute will be set to

Source:

Spacer.js, line 351

(inner) children()

Returns NodeList

Source:

Spacer.js, line 460

Returns:

NodeList

(inner) click()

Clicks the element

Source:

Spacer.js, line 267

(inner) clone(keepChildrenopt)

Clones the element

Parameters:

Name	Type	Attributes	Description
`keepChildren`	boolean	<optional>	Keep child elements

Source:

Spacer.js, line 332

Returns:

Cloned Node

(inner) compareNode(node)

Compares two nodes to see if they are similar

Parameters:

Name	Type	Description
`node`	HTMLElement \| Node	HTMLElement or Node

Source:

Spacer.js, line 369

Returns:

Boolean

(inner) contains(node)

Checks if the element contains a Node

Parameters:

Name	Type	Description
`node`	Node	HTML Node to check for

Source:

Spacer.js, line 324

Returns:

Boolean

(inner) css(pseudoElementopt)

Retuns computedStyle of element

Parameters:

Name	Type	Attributes	Description
`pseudoElement`	string	<optional>	A pseudoElement

Source:

Spacer.js, line 532

Returns:

CSSStyleDeclaration | null

(inner) dbclick()

Clicks the element twice

Source:

Spacer.js, line 274

(inner) debug(…args)

Console logs any arguments

Parameters:

Name	Type	Attributes	Description
`args`	any	<repeatable>	Any arguments

Source:

Spacer.js, line 491

(inner) deleteMeta()

Removes metadata

Source:

Spacer.js, line 735

(inner) each(cb)

Iterate through a nodelist

Parameters:

Name	Type	Description
`cb`	function	Callback with first parameter being value and last being index

Source:

Spacer.js, line 604

(inner) empty()

Removes all empty child nodes

Source:

Spacer.js, line 544

(inner) fadeIn(intensityopt)

Fades in the selected element

Parameters:

Name	Type	Attributes	Default	Description
`intensity`	number	<optional>	0.05	Intensity of the fade

Source:

Spacer.js, line 660

(inner) fadeOut(intensityopt)

Fades out the selected element

Parameters:

Name	Type	Attributes	Default	Description
`intensity`	number	<optional>	0.05	Intensity of the fade

Source:

Spacer.js, line 636

(inner) first(nodeopt)

Returns the first child element as an HTMLelement

Parameters:

Name	Type	Attributes	Default	Description
`node`	boolean	<optional>	false	Determines the returned value as a HTMLElement or Node

Source:

Spacer.js, line 578

Returns:

HTMLElement

(inner) focus()

Focuses the element

Source:

Spacer.js, line 282

(inner) hasAttr(attribute)

Checks if the element has an certain attribute

Parameters:

Name	Type	Description
`attribute`	string	Attribute

Source:

Spacer.js, line 343

Returns:

Boolean

(inner) hasChildren(normalize)

Checks if an element has any child nodes

Parameters:

Name	Type	Description
`normalize`	boolean	Boolean to normalize before checking for child nodes

Source:

Spacer.js, line 360

Returns:

Boolean

(inner) hide()

Adds the hidden class that was set with setMeta()

Source:

Spacer.js, line 418

(inner) hover()

Adds the hoverClass that was set with setMeta(metaObj)

Source:

Spacer.js, line 498

(inner) html(str)

Appends the a string to the selected element innerHTML

Parameters:

Name	Type	Description
`str`	string	String to be inserted in the innerHTML

Source:

Spacer.js, line 252

(inner) keydown(cb)

Listens for the keydown event

Parameters:

Name	Type	Description
`cb`	function	Callback

Source:

Spacer.js, line 475

(inner) keyup(cb)

Listens for the keyup event

Parameters:

Name	Type	Description
`cb`	function	Callback

Source:

Spacer.js, line 483

(inner) kill()

Removes the element

Source:

Spacer.js, line 763

(inner) last(nodeopt)

Returns the last child element as an HTMLelement

Parameters:

Name	Type	Attributes	Default	Description
`node`	boolean	<optional>	false	Determines the returned value as a HTMLElement or Node

Source:

Spacer.js, line 586

Returns:

HTMLElement

(inner) normalize()

Converts text nodes into text content

Source:

Spacer.js, line 375

(inner) offset()

Returns the top and left coordianate

Source:

Spacer.js, line 756

Returns:

object.top & object.left

(inner) on(event, cb)

Sets on event listener and runs cb on event

Parameters:

Name	Type	Description
`event`	string	One event or multiple events seperated by one space
`cb`	function \| Array.<function()>	A callback function or an array of callback functions that will be called by their index of events

Source:

Spacer.js, line 428

(inner) parent()

Returns the parent element

Source:

Spacer.js, line 570

Returns:

HTMLElement

(inner) prepend(elem)

Appends the a Node or string to a parent element

Parameters:

Name	Type	Description
`elem`	HTMLElement \| Node \| String	Selector string or HTMLElement

Source:

Spacer.js, line 234

(inner) prependList(elementlist)

Appends a list of HTML Elements

Parameters:

Name	Type	Description
`elementlist`	Array.<HTMLElement>	Array of Elements or nodes

Source:

Spacer.js, line 242

(inner) prependTo(parent)

Appends the child element to a parent element

Parameters:

Name	Type	Description
`parent`	string \| HTMLElement	Selector string

Source:

Spacer.js, line 218

(inner) randomChild()

Returns a random child

Source:

Spacer.js, line 627

Returns:

HTMLElement | Node | null

(inner) removeChild(node)

Removes a child node

Parameters:

Name	Type	Description
`node`	HTMLElement \| Node	HTMLElement or Node

Source:

Spacer.js, line 383

(inner) removeChildren()

Removes all child nodes

Source:

Spacer.js, line 560

(inner) removeClass(className)

Removes a class from the element

Parameters:

Name	Type	Description
`className`	string	Class Name

Source:

Spacer.js, line 452

(inner) removeMetaProp(metaKey)

Removes a property of Metadata

Parameters:

Name	Type	Description
`metaKey`	string	hiddenClass, hoverClass, or activeClass

Source:

Spacer.js, line 720

(inner) replaceChild(newChild, oldChild)

Replaces a child element

Parameters:

Name	Type	Description
`newChild`	HTMLElement \| Node	New Element
`oldChild`	HTMLElement \| Node	Old Element

Source:

Spacer.js, line 392

(inner) rotate(cssValue)

Sets the rotation of an element

Parameters:

Name	Type	Description
`cssValue`	string	Any valid CSS Rotate Tranform

Source:

Spacer.js, line 710

Example

myElement.rotate('0.5turn')

(inner) setMeta(obj)

Sets the "metadata" of a element for showing passed classes, and other methods

Parameters:

Name Type Description

obj

object

Meta Data Object

Properties

Name	Type	Attributes	Description
`hiddenClass`	string	<optional>	Class to be used when using hide() or show()
`hoverClass`	string	<optional>	Class to be used when using hover() or unhover()
`activeClass`	string	<optional>	Class to be used when using active() or unactive()

Source:

Spacer.js, line 403

(inner) setTitle()

Sets the element's title

Source:

Spacer.js, line 296

(inner) show()

Removes the hidden class that was set with setMeta()

Source:

Spacer.js, line 410

(inner) size()

Returns the Bounding Client Rect

Source:

Spacer.js, line 620

Returns:

DomRect

(inner) sleep(ms)

Sleep promise

Parameters:

Name	Type	Description
`ms`	number	Millisecond delay

Source:

Spacer.js, line 468

Returns:

Promise

(inner) sToView(alignToopt)

Scrolls the element into view

Parameters:

Name	Type	Attributes	Description
`alignTo`	boolean	<optional>	True or false, true lines up element to the top of the screen

Source:

Spacer.js, line 304

(inner) text(str)

Appends the a string to the selected element innerText

Parameters:

Name	Type	Description
`str`	string	String to be inserted in the innerText

Source:

Spacer.js, line 260

(inner) toStr()

Returns an HTML Element into a string

Source:

Spacer.js, line 316

Returns:

String or null

(inner) transform(cssValue)

Sets the transform of an element

Parameters:

Name	Type	Description
`cssValue`	string	Any valid CSS Tranform

Source:

Spacer.js, line 699

Example

myElement.transform('translate(120px, 50%)')

(inner) trigger(event)

Triggers an event

Parameters:

Name	Type	Description
`event`	string	Event

Source:

Spacer.js, line 612

(inner) unactive()

Adds the activeClass that was set with setMeta(metaObj)

Source:

Spacer.js, line 522

(inner) unfocus()

Removes focus from the element

Source:

Spacer.js, line 289

(inner) unhover()

Adds the hoverClass that was set with setMeta(metaObj)

Source:

Spacer.js, line 506

(inner) val(newValueopt)

Returns the value of an input element and sets the input value

Parameters:

Name	Type	Attributes	Description
`newValue`	string \| any	<optional>	New value to set the input value to, optional

Source:

Spacer.js, line 746

Returns:

HTMLInputElement Value

Namespace: _

Parameters:

Members

(inner) element

(inner) fn

(inner) meta

(inner) nodelist

(inner) state

Properties:

Methods

(inner) __(selector)

Parameters:

(inner) active()

(inner) addClass(className)

Parameters:

(inner) animate(cssProperty, value, time)

Parameters:

(inner) append(elem)

Parameters:

(inner) appendChild(child)

Parameters:

(inner) appendList(elementlist)

Parameters:

(inner) appendTo(parent)

Parameters:

(inner) at(index)

Parameters:

Returns:

Example

(inner) attr(attribute, value)

Parameters:

(inner) children()

Returns:

(inner) click()

(inner) clone(keepChildrenopt)

Parameters:

Returns:

(inner) compareNode(node)

Parameters:

Returns:

(inner) contains(node)

Parameters:

Returns:

(inner) css(pseudoElementopt)

Parameters:

Returns:

(inner) dbclick()

(inner) debug(…args)

Parameters:

(inner) deleteMeta()

(inner) each(cb)

Parameters:

(inner) empty()

(inner) fadeIn(intensityopt)

Parameters:

(inner) fadeOut(intensityopt)

Parameters:

(inner) first(nodeopt)

Parameters:

Returns:

(inner) focus()

(inner) hasAttr(attribute)

Parameters:

Returns:

(inner) hasChildren(normalize)

Parameters:

Returns:

(inner) hide()

(inner) hover()

(inner) html(str)

Parameters:

(inner) keydown(cb)

Parameters:

(inner) keyup(cb)

Parameters:

(inner) kill()

(inner) last(nodeopt)

Parameters:

Returns:

(inner) normalize()