JSDoc: Class: domhelper

new domhelper()

A module that adds simple dom utility functionality.

Author:

yaw joseph etse

Source:

domhelper.js, line 21

Methods

<static> closetElement(element) → {node}

Returns cloaset DOM element.

Parameters:

Name	Type	Description
`element`	node	html dom element

Source:

domhelper.js, line 105

Returns:

closet node element

Type: node

<static> elementContentWrapInner(element, innerElement)

Wraps inner elements

Parameters:

Name	Type	Description
`element`	node	html dom element
`innerElement`	node	element to wrap html dom element

Source:

domhelper.js, line 152

<static> elementHideCss(element)

Hides DOM elements.

Parameters:

Name	Type	Description
`element`	node	html dom element

Source:

domhelper.js, line 133

<static> elementShowCss(element)

Shows DOM elements.

Parameters:

Name	Type	Description
`element`	node	html dom element

Source:

domhelper.js, line 142

<static> elementWrap(element, wrapperElement)

Wraps element with wrapper

Parameters:

Name	Type	Description
`element`	node	html dom element
`wrapperElement`	node	element to wrap html dom element

Source:

domhelper.js, line 171

<static> getElementSelector(element) → {string}

get element selector

Parameters:

Name	Type	Description
`element`	node	html dom element

Source:

domhelper.js, line 227

Returns:

query selector string

Type: string

<static> getHighIndex(selector) → {number}

returns the highest zindex

Parameters:

Name	Type	Description
`selector`	string	query selector

Source:

domhelper.js, line 29

Returns:

highest z-index

Type: number

<static> getParentElement(element, selector, selectorType)

get parent element

Parameters:

Name	Type	Description
`element`	node	html dom element
`selector`	string	selector
`selectorType`	string	selector type (id or class)

Source:

domhelper.js, line 246

<static> getPosition(element) → {object}

get scroll position of element

Parameters:

Name	Type	Description
`element`	node	html dom element

Source:

domhelper.js, line 209

Returns:

position element

Type: object

<static> getScrollTop(element) → {number}

get scroll position of element

Parameters:

Name	Type	Description
`element`	node	html dom element

Source:

domhelper.js, line 186

Returns:

position of scroll

Type: number

<static> nodeIndexOfNodeList(nodelist, element) → {number}

converts idnex of node in nodelist

Parameters:

Name	Type	Description
`nodelist`	object	html dom element
`element`	object	html dom element

Source:

domhelper.js, line 81

Returns:

index of element in nodelist

Type: number

<static> nodelistToArray(nl) → {array}

converts nodelists to arrays

Parameters:

Name	Type	Description
`nl`	node	html dom element

Source:

domhelper.js, line 91

Returns:

array of html nodes

Type: array

<static> removeAllClassAndToggle(elementCollection, element, name)

toggles class across nodelist/elementcollection

Parameters:

Name	Type	Description
`elementCollection`	object	html dom element
`element`	object	html dom element
`name`	string	of class!

Source:

domhelper.js, line 58

<static> removeElement(elementCollection)

removes element from dom

Parameters:

Name	Type	Description
`elementCollection`	object	html dom element

Source:

domhelper.js, line 70