Modules
detect
-
detect
-
.getUserAgent ⇒
Object -
.hasHistory :
Boolean -
.hasTouch :
Boolean -
.isAndroid :
Boolean -
.isIOS :
Boolean -
.isLinux :
Boolean -
.isMac :
Boolean -
.isWindows :
Boolean -
.supportBoxModel ⇒
Boolean -
.supportsHTML5Video ⇒
Boolean
-
.getUserAgent ⇒
detect.getUserAgent ⇒ Object
Creates an object with user agent information
Kind: static property of detect
Url: http://stackoverflow.com/questions/5916900/how-can-you-detect-the-version-of-a-browser
detect.hasHistory : Boolean
window.history support
Kind: static property of detect
detect.hasTouch : Boolean
Touch support
Kind: static property of detect
detect.isAndroid : Boolean
Android useragent sniff
Kind: static property of detect
detect.isIOS : Boolean
iOS useragent sniff
Kind: static property of detect
detect.isLinux : Boolean
Linux useragent sniff
Kind: static property of detect
detect.isMac : Boolean
Macintoch useragent sniff
Kind: static property of detect
detect.isWindows : Boolean
Windows useragent sniff
Kind: static property of detect
detect.supportBoxModel ⇒ Boolean
Box model support
Kind: static property of detect
detect.supportsHTML5Video ⇒ Boolean
HTML5 video support
Kind: static property of detect
functions
-
functions
- .addClass(el, cls)
- .addEvent(el, type, fn)
- .addEventOnce(el, type, fn)
- .addHtml(node)
-
.ajax(options) ⇒
Promise -
.assign(target, ...source) ⇒
Object -
.clamp(min, max, value1) ⇒
Number/Function -
.cloneArray(src) ⇒
Array -
.cloneArrayDeep(src) ⇒
Array -
.cloneObject(src) ⇒
Object -
.cloneObjectDeep(src) ⇒
Object -
.createEventTemplate(type, target, eventData) ⇒
Object -
.debounce(fn, wait, scope, immediate) ⇒
function -
.delegate(selector, fn, ctx) ⇒
function - .exitFullscreen(el)
-
.fireEvent(el, type, bubble, cancelable) ⇒
Boolean - .forEachShift(collection, fn)
-
.getElementOffset(el) ⇒
Object -
.getEventTarget(e) ⇒
* -
.getIframeFromWindow(window) ⇒
HTMLNode/Boolean -
.getObjectValues(obj, keys) ⇒
Array.<*> -
.getParent(el, selector) ⇒
HTMLNode/Boolean -
.getPrevious(el, selector) ⇒
HTMLElement/Boolean -
.getParentUntil(el, selector) ⇒
Object -
.getPreviousElementUntil(el, selector) ⇒
Object -
.getScrollLeft(el) ⇒
Number -
.getScrollTop(el) ⇒
Number -
.getNamespaceKey(abbr) ⇒
String -
.getWindowScrollLeft() ⇒
Number -
.getWindowScrollTop() ⇒
Number -
.hasClass(el, cls) ⇒
Boolean -
.hasOwnProperty(obj, key) ⇒
Boolean -
.inherit(src, props) ⇒
Object -
.insertBefore(child, ref) ⇒
HTMLElement -
.isArray(src) ⇒
Boolean -
.isArticleAdSlot(placement) ⇒
Boolean -
.isDefined(value) ⇒
Boolean -
.isEmptyString(value) ⇒
Boolean -
.isElement(value) ⇒
Boolean -
.isHeaderAdSlot(placement) ⇒
Boolean -
.isObject(src) ⇒
Boolean -
.isSplashAdSlot(placement) ⇒
Boolean -
.isWindow(win) ⇒
Boolean -
.loadScript(url, options) ⇒
Promise -
.loadSocialScripts() ⇒
Promise -
.not(value) ⇒
Boolean - .onPageLoad(loadFn)
- .onPageReady(readyFn)
-
.padValue(value, width, chr) ⇒
String -
.randomUUID() ⇒
String - .removeClass(el, cls)
- .removeElement(el)
- .removeEvent(el, type, fn)
-
.throttle(fn, threshhold, scope) ⇒
function -
.toBoolean(value) ⇒
Boolean - .toggleClass(el, cls)
-
.unescapeJinjaValue(value) ⇒
*
functions.addClass(el, cls)
Adds a class to an element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| cls | String |
functions.addEvent(el, type, fn)
Adds an event to an element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| type | String |
| fn | function |
functions.addEventOnce(el, type, fn)
Adds an event that will fire once and then remove itself
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| type | String |
| fn | function |
functions.addHtml(node)
Adds html to a node
Kind: static method of functions
| Param | Type |
|---|---|
| node | HTMLElement |
functions.ajax(options) ⇒ Promise
Basic ajax function
Kind: static method of functions
| Param | Type |
|---|---|
| options | Object |
functions.assign(target, ...source) ⇒ Object
Assigns the values of the other sources to the target
Kind: static method of functions
| Param | Type |
|---|---|
| target | Object |
| ...source | Object |
functions.clamp(min, max, value1) ⇒ Number/Function
Clamps a value to the min and max. Also set up to allow currying.
Kind: static method of functions
| Param | Type |
|---|---|
| min | Number |
| max | Number |
| value1 | Number |
functions.cloneArray(src) ⇒ Array
Clones an array
Kind: static method of functions
| Param | Type |
|---|---|
| src | Array |
functions.cloneArrayDeep(src) ⇒ Array
Clones an array while recursively cloning the items inside
Kind: static method of functions
| Param | Type |
|---|---|
| src | Array |
functions.cloneObject(src) ⇒ Object
Clones an object
Kind: static method of functions
| Param | Type |
|---|---|
| src | Object |
functions.cloneObjectDeep(src) ⇒ Object
Clones an object whilst recursively cloning the descendants
Kind: static method of functions
| Param | Type |
|---|---|
| src | Object |
functions.createEventTemplate(type, target, eventData) ⇒ Object
Creates an object for events
Kind: static method of functions
| Param | Type | Description |
|---|---|---|
| type | String |
The type of event |
| target | Object |
The thing that emitted the event |
| eventData | Object |
Some data |
functions.debounce(fn, wait, scope, immediate) ⇒ function
Debounce function, allows one function to be ran wait milliseconds after.
Kind: static method of functions
| Param | Type | Description |
|---|---|---|
| fn | function |
|
| wait | Number |
Number of milliseconds |
| scope | Object |
|
| immediate | Boolean |
functions.delegate(selector, fn, ctx) ⇒ function
Creates a function that will delegate events to a selector
Kind: static method of functions
| Param | Type |
|---|---|
| selector | String |
| fn | function |
| ctx | * |
functions.exitFullscreen(el)
Exits fullscreen mode for the element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
functions.fireEvent(el, type, bubble, cancelable) ⇒ Boolean
Fires an event on an element
Kind: static method of functions
Returns: Boolean - Was the event cancelled?
| Param | Type | Description |
|---|---|---|
| el | HTMLElement |
|
| type | String |
The type of event |
| bubble | Boolean |
Should the event bubble? |
| cancelable | Boolean |
Should the event be cancelable? |
functions.forEachShift(collection, fn)
Loop over a collection and shift the item from the collection
Kind: static method of functions
| Param | Type |
|---|---|
| collection | Array |
| fn | function |
functions.getElementOffset(el) ⇒ Object
Gets the elements offset. Based off of jquerys implementation
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
functions.getEventTarget(e) ⇒ *
Gets the event target
Kind: static method of functions
Returns: * - The target of the event
| Param | Type | Description |
|---|---|---|
| e | Object |
The event information |
functions.getIframeFromWindow(window) ⇒ HTMLNode/Boolean
Gets the iframe element based on the window
Kind: static method of functions
| Param | Type |
|---|---|
| window | Window |
functions.getObjectValues(obj, keys) ⇒ Array.<*>
Gets the values from an object. If keys are specified, it will only get the values of those keys.
Kind: static method of functions
| Param | Type | Description |
|---|---|---|
| obj | Object |
Source object |
| keys | Array.<String> |
functions.getParent(el, selector) ⇒ HTMLNode/Boolean
Gets the parent element matching the selector. If it doesn't match, returns nothing
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| selector | String |
functions.getPrevious(el, selector) ⇒ HTMLElement/Boolean
Gets the previous element matching the selector. If it doesn't match, returns false
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLElement |
| selector | String |
functions.getParentUntil(el, selector) ⇒ Object
Gets the parent till the selector or the root.
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| selector | String |
functions.getPreviousElementUntil(el, selector) ⇒ Object
Gets the previous element till the selector or the root
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| selector | String |
functions.getScrollLeft(el) ⇒ Number
Gets the scroll left of the element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode/Window |
functions.getScrollTop(el) ⇒ Number
Gets the scroll top of the element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode/Window |
functions.getNamespaceKey(abbr) ⇒ String
Creates a key based on the brand abbreviation
Kind: static method of functions
| Param | Type |
|---|---|
| abbr | String |
functions.getWindowScrollLeft() ⇒ Number
Gets the scrollleft of the window
Kind: static method of functions
functions.getWindowScrollTop() ⇒ Number
Gets the scrolltop of the window
Kind: static method of functions
functions.hasClass(el, cls) ⇒ Boolean
Checks if the element has a class
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| cls | String |
functions.hasOwnProperty(obj, key) ⇒ Boolean
hasOwnProperty that prevents contamination from the object being tested
Kind: static method of functions
| Param | Type |
|---|---|
| obj | Object |
| key | String |
functions.inherit(src, props) ⇒ Object
Creates a new object based from src. Then copies over any properties.
Kind: static method of functions
| Param | Type |
|---|---|
| src | Object |
| props |
Object | Undefined
|
functions.insertBefore(child, ref) ⇒ HTMLElement
Inserts the child element before the reference
Kind: static method of functions
Returns: HTMLElement - The child
| Param | Type |
|---|---|
| child | HTMLElement |
| ref | HTMLElement |
functions.isArray(src) ⇒ Boolean
Checks if the src is an array
Kind: static method of functions
| Param | Type |
|---|---|
| src | * |
functions.isArticleAdSlot(placement) ⇒ Boolean
Checks if the placement is in an article slot
Kind: static method of functions
| Param | Type |
|---|---|
| placement | String |
functions.isDefined(value) ⇒ Boolean
Checks if a value is defined
Kind: static method of functions
| Param | Type |
|---|---|
| value | * |
functions.isEmptyString(value) ⇒ Boolean
Checks if the value is an empty string
Kind: static method of functions
| Param | Type |
|---|---|
| value | * |
functions.isElement(value) ⇒ Boolean
Checks if the value is an element
Kind: static method of functions
| Param | Type |
|---|---|
| value | * |
functions.isHeaderAdSlot(placement) ⇒ Boolean
Checks if the placement is a header slot
Kind: static method of functions
| Param | Type |
|---|---|
| placement | String |
functions.isObject(src) ⇒ Boolean
Checks if the src is an object
Kind: static method of functions
| Param | Type |
|---|---|
| src | * |
functions.isSplashAdSlot(placement) ⇒ Boolean
Checks if the placement is a splash slot
Kind: static method of functions
| Param | Type |
|---|---|
| placement | String |
functions.isWindow(win) ⇒ Boolean
Checks if win is a window element
Kind: static method of functions
| Param | Type |
|---|---|
| win | * |
functions.loadScript(url, options) ⇒ Promise
Loads a script file into the page
Kind: static method of functions
| Param | Type |
|---|---|
| url | String |
| options | Object |
functions.loadSocialScripts() ⇒ Promise
Loads any social scripts. Includes twitter, facebook, vine, instagram and imgur
Kind: static method of functions
functions.not(value) ⇒ Boolean
Inverts the value
Kind: static method of functions
| Param | Type |
|---|---|
| value | * |
functions.onPageLoad(loadFn)
Runs loadFn once the page has loaded
Kind: static method of functions
| Param | Type |
|---|---|
| loadFn | function |
functions.onPageReady(readyFn)
Runs readyFn once the page is ready
Kind: static method of functions
| Param | Type |
|---|---|
| readyFn | function |
functions.padValue(value, width, chr) ⇒ String
Pads a number
Kind: static method of functions
| Param | Type |
|---|---|
| value | Number |
| width | Number |
| chr | String |
functions.randomUUID() ⇒ String
Generates a random id
Kind: static method of functions
functions.removeClass(el, cls)
Removes a class from an element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| cls | String |
functions.removeElement(el)
Removes the element from the tree
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLElement |
functions.removeEvent(el, type, fn)
Removes an event from an element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| type | String |
| fn | function |
functions.throttle(fn, threshhold, scope) ⇒ function
Throttles an event being fired by the threshold
Kind: static method of functions
| Param | Type | Description |
|---|---|---|
| fn | function |
|
| threshhold | Number |
Milliseconds to throttle by |
| scope | Object |
functions.toBoolean(value) ⇒ Boolean
Converts a value to a boolean
Kind: static method of functions
| Param | Type |
|---|---|
| value | * |
functions.toggleClass(el, cls)
Toggles a class on an element
Kind: static method of functions
| Param | Type |
|---|---|
| el | HTMLNode |
| cls | String |
functions.unescapeJinjaValue(value) ⇒ *
Unescapes a value from jinja
Kind: static method of functions
| Param | Type |
|---|---|
| value | * |