boost.js

Simplifying browser APIs – from DOM manipulation to web components, event handling, animations, routing, multi-threading and AJAX requests.

Ajax

Animate

Audio

Browser

Colour

Draggable

Elements

Element

Wrapper class for DOM elements.

Kind: global class


element.id : string

Kind: instance property of Element


element.data : DOMStringMap

Kind: instance property of Element


element.tagName : string

Kind: instance property of Element


element.attributes : Array.<Attr>

Kind: instance property of Element


element.value : string

Kind: instance property of Element


element.value

Kind: instance property of Element

Param Type
v string

element.html : string

Kind: instance property of Element


element.html

Kind: instance property of Element

Param Type
h string

element.text : string

Kind: instance property of Element


element.text

Kind: instance property of Element

Param Type
t string

element.bounds : DOMRect

Kind: instance property of Element


element.offsetTop : number

Kind: instance property of Element


element.offsetLeft : number

Kind: instance property of Element


element.offsetParent : Element

Kind: instance property of Element
Returns: Element - This element's offset parent.


element.width : number

Kind: instance property of Element
Returns: number - This element's width, including border and padding.


element.height : number

Kind: instance property of Element
Returns: number - This element's height, including border and padding.


element.innerWidth : number

Kind: instance property of Element
Returns: number - This element's width, excluding border and padding.


element.innerHeight : number

Kind: instance property of Element
Returns: number - This element's height, excluding border and padding.


element.outerWidth : number

Kind: instance property of Element
Returns: number - This element's width, including margins.


element.outerHeight : number

Kind: instance property of Element
Returns: number - This element's height, including margins.


element.positionTop : number

Kind: instance property of Element


element.positionLeft : number

Kind: instance property of Element


element.boxCenter : Point

Kind: instance property of Element


element.isInViewport : boolean

Checks if this element is currently visible in the viewport.

Kind: instance property of Element


element.scrollWidth : number

Kind: instance property of Element


element.scrollHeight : number

Kind: instance property of Element


element.scrollTop : number

Kind: instance property of Element


element.scrollLeft : number

Kind: instance property of Element


element.scrollTop

Kind: instance property of Element

Param Type
y number

element.scrollLeft

Kind: instance property of Element

Param Type
x number

element.next : Element

Kind: instance property of Element
Returns: Element - This element's next sibling, or null.


element.prev : Element

Kind: instance property of Element
Returns: Element - This element's previous sibling, or null.


element.parent : Element

Kind: instance property of Element
Returns: Element - This element's parent, or null.


element.addClass(className)

Kind: instance method of Element

Param Type Description
className string Multiple space-separated classes to add.

element.removeClass(className)

Kind: instance method of Element

Param Type Description
className string Multiple space-separated classes to add.

element.hasClass(className)

Kind: instance method of Element

Param Type
className string

element.toggleClass(className)

Kind: instance method of Element

Param Type
className string

element.attr(attr) : string

Kind: instance method of Element

Param Type
attr string

element.hasAttr(attr) : boolean

Kind: instance method of Element

Param Type
attr string

element.setAttr(attr, value)

Kind: instance method of Element

Param Type
attr string
value string

element.removeAttr(attr)

Kind: instance method of Element

Param Type
attr string

element.translateX(x)

Kind: instance method of Element

Param Type
x number

element.translateY(y)

Kind: instance method of Element

Param Type
y number

element.is(selector) : boolean

Checks if an element matches a given CSS selector.

Kind: instance method of Element

Param Type
selector string

element.$(selector) : Element

The first child element matching a given selector.

Kind: instance method of Element

Param Type
selector string

element.$$(selector) : Array.<Element>

All child elements matching a given selector.

Kind: instance method of Element

Param Type
selector string

element.animate(rules, [duration], [delay], [ease]) : *

Animates multiple CSS properties of this element, with a given duration, delay and ease function.

Kind: instance method of Element

Param Type
rules Object.<string, (*|Array)>
[duration] number
[delay] number
[ease] string

$window : WindowElement

Kind: global constant


$html : WindowElement

Kind: global constant


$body : WindowElement

Kind: global constant


$(query, [context]) : Element

Kind: global function

Param Type
query string | Element
[context] Element

$$(selector, [context]) : Array.<Element>

Kind: global function

Param Type
selector string
[context] Element

$N(tag, [attributes], [parent]) : Element

Kind: global function

Param Type
tag string
[attributes] Object.<string, string>
[parent] Element

$$N(html) : Array.<Element>

Kind: global function

Param Type
html string

table(data) : string

Kind: global function

Param Type
data Array.<Array.<string>>

Events

Router

Templates

Thread

Webcomponents