DOM Class
Provides DOM helper methods.
Item Index
Methods
- _bruteContains
- _getDoc
- _getRegExp
- _getWin
- addClass
- addHTML
- byId
- contains
- create
- docHeight
- docScrollX
- docScrollY
- docWidth
- elementByAxis
- getAttribute
- getComputedStyle
- getScrollbarWidth
- getStyle
- getText
- getX
- getXY
- getY
- hasClass
- inDoc
- inRegion
- intersect
- inViewportRegion
- region
- removeClass
- replaceClass
- setAttribute
- setHeight
- setStyle
- setStyles
- setText
- setWidth
- setX
- setXY
- setY
- swapXY
- toggleClass
- viewportRegion
- winHeight
- winWidth
Methods
_bruteContains
-
element -
needle
Brute force version of contains. Used for browsers without contains support for non-HTMLElement Nodes (textNodes, etc).
Parameters:
-
elementHTMLElementThe containing html element.
-
needleHTMLElementThe html element that may be contained.
Returns:
_getDoc
-
element
returns the appropriate document.
Parameters:
-
elementHTMLElementoptional Target element.
Returns:
_getRegExp
-
str -
flags
Memoizes dynamic regular expressions to boost runtime performance.
Parameters:
Returns:
_getWin
-
element
returns the appropriate window.
Parameters:
-
elementHTMLElementoptional Target element.
Returns:
addClass
-
element -
className
Adds a class name to a given DOM element.
Parameters:
-
elementHTMLElementThe DOM element.
-
classNameStringthe class name to add to the class attribute
addHTML
-
node -
content -
where
Inserts content in a node at the given location
Parameters:
-
nodeHTMLElementThe node to insert into
-
contentHTMLElement | Array | HTMLCollectionThe content to be inserted
-
whereHTMLElementWhere to insert the content If no "where" is given, content is appended to the node Possible values for "where"
- HTMLElement
- The element to insert before
- "replace"
- Replaces the existing HTML
- "before"
- Inserts before the existing HTML
- "before"
- Inserts content before the node
- "after"
- Inserts content after the node
byId
-
id -
doc
Returns the HTMLElement with the given ID (Wrapper for document.getElementById).
Parameters:
Returns:
contains
-
element -
needle
Determines whether or not one HTMLElement is or contains another HTMLElement.
Parameters:
-
elementHTMLElementThe containing html element.
-
needleHTMLElementThe html element that may be contained.
Returns:
create
-
html -
doc
Creates a new dom node using the provided markup string.
Parameters:
-
htmlStringThe markup used to create the element
-
docHTMLDocumentAn optional document context
Returns:
docScrollX
()
Number
Amount page has been scroll horizontally
Returns:
docScrollY
()
Number
Amount page has been scroll vertically
Returns:
elementByAxis
-
element -
axis -
fn -
all
Searches the element by the given axis for the first matching element.
Parameters:
-
elementHTMLElementThe html element.
-
axisStringThe axis to search (parentNode, nextSibling, previousSibling).
-
fnFunctionoptional An optional boolean test to apply.
-
allBooleanoptional Whether all node types should be returned, or just element nodes. The optional function is passed the current HTMLElement being tested as its only argument. If no function is given, the first element is returned.
Returns:
getAttribute
-
el -
attr
Provides a normalized attribute interface.
Parameters:
-
elHTMLElementThe target element for the attribute.
-
attrStringThe attribute to get.
Returns:
getComputedStyle
-
An -
att
Returns the computed style for the given node.
Parameters:
-
AnHTMLElementHTMLElement to get the style from.
-
attStringThe style property to get.
Returns:
getScrollbarWidth
()
Number
Gets the width of vertical scrollbars on overflowed containers in the body content.
Returns:
getStyle
-
An -
att
Returns the current style value for the given property.
Parameters:
-
AnHTMLElementHTMLElement to get the style from.
-
attStringThe style property to get.
getText
-
element
Returns the text content of the HTMLElement.
Parameters:
-
elementHTMLElementThe html element.
Returns:
getX
-
element
Gets the current X position of an element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:
-
elementObjectThe target element
Returns:
getXY
-
element
Gets the current position of an element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:
-
elementObjectThe target element
Returns:
TODO: test inDocument/display?
getY
-
element
Gets the current Y position of an element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
Parameters:
-
elementObjectThe target element
Returns:
hasClass
-
element -
className
Determines whether a DOM element has the given className.
Parameters:
-
elementHTMLElementThe DOM element.
-
classNameStringthe class name to search for
Returns:
inDoc
-
element -
doc
Determines whether or not the HTMLElement is part of the document.
Parameters:
-
elementHTMLElementThe containing html element.
-
docHTMLElementoptional The document to check.
Returns:
inRegion
-
node -
node2 -
all -
altRegion
Check if any part of this node is in the passed region
Parameters:
-
nodeObjectThe node to get the region from
-
node2ObjectThe second node to get the region from or an Object literal of the region
-
allBooleanShould all of the node be inside the region
-
altRegionObjectAn object literal containing the region for this node if we already have the data (for performance e.g. DragDrop)
Returns:
intersect
-
element -
element2 -
altRegion
Find the intersect information for the passed nodes.
Parameters:
-
elementHTMLElementThe first element
-
element2HTMLElement | ObjectThe element or region to check the interect with
-
altRegionObjectAn object literal containing the region for the first element if we already have the data (for performance e.g. DragDrop)
Returns:
inViewportRegion
-
element -
all -
altRegion
Check if any part of this element is in the viewport
Parameters:
-
elementHTMLElementThe DOM element.
-
allBooleanShould all of the node be inside the region
-
altRegionObjectAn object literal containing the region for this node if we already have the data (for performance e.g. DragDrop)
Returns:
region
-
element
Returns an Object literal containing the following about this element: (top, right, bottom, left)
Parameters:
-
elementHTMLElementThe DOM element.
Returns:
removeClass
-
element -
className
Removes a class name from a given element.
Parameters:
-
elementHTMLElementThe DOM element.
-
classNameStringthe class name to remove from the class attribute
replaceClass
-
element -
oldClassName -
newClassName
Replace a class with another class for a given element. If no oldClassName is present, the newClassName is simply added.
Parameters:
-
elementHTMLElementThe DOM element
-
oldClassNameStringthe class name to be replaced
-
newClassNameStringthe class name that will be replacing the old class name
setAttribute
-
el -
attr -
val
Provides a normalized attribute interface.
Parameters:
-
elHTMLElementThe target element for the attribute.
-
attrStringThe attribute to set.
-
valStringThe value of the attribute.
setHeight
-
element -
size
Sets the height of the element to the given size, regardless of box model, border, padding, etc.
Parameters:
-
elementHTMLElementThe DOM element.
-
sizeString | NumberThe pixel height to size to
setStyle
-
An -
att -
val
Sets a style property for a given element.
Parameters:
-
AnHTMLElementHTMLElement to apply the style to.
-
attStringThe style property to set.
-
valString | NumberThe value.
setStyles
-
node -
hash
Sets multiple style properties.
Parameters:
-
nodeHTMLElementAn HTMLElement to apply the styles to.
-
hashObjectAn object literal of property:value pairs.
setText
-
element -
content
Sets the text content of the HTMLElement.
Parameters:
-
elementHTMLElementThe html element.
-
contentStringThe content to add.
setWidth
-
element -
size
Sets the width of the element to the given size, regardless of box model, border, padding, etc.
Parameters:
-
elementHTMLElementThe DOM element.
-
sizeString | NumberThe pixel height to size to
setX
-
element -
x
Set the X position of an html element in page coordinates, regardless of how the element is positioned. The element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
setXY
-
element -
xy -
noRetry
Set the position of an html element in page coordinates. The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
setY
-
element -
y
Set the Y position of an html element in page coordinates, regardless of how the element is positioned. The element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
toggleClass
-
element -
className -
addClass
If the className exists on the node it is removed, if it doesn't exist it is added.
Parameters:
-
elementHTMLElementThe DOM element
-
classNameStringthe class name to be toggled
-
addClassBooleanoptional boolean to indicate whether class should be added or removed regardless of current state
viewportRegion
()
Object
Returns an Object literal containing the following about the visible region of viewport: (top, right, bottom, left)
