---

Classes

• _global_
• Simples
• Simples.ajaxDefaults
• Simples.Animation
• Simples.Animation.tweens
• Simples.Event
• Simples.fn

---

Namespace Simples.fn

Simples.fn
Defined in: core.js.

Namespace Summary

Constructor Attributes	Constructor Name and Description
	Simples.fn the instance of a Simples object functions / instance methods

Field Summary

Field Attributes	Field Name and Description
<static>	Simples.fn.length The count of items on the Simples object
<static>	Simples.fn.selector The selector used to create the Simples object
<static>	Simples.fn.version The version of the Simples library

Method Summary

Method Attributes	Method Name and Description
<static>	Simples.fn.add(elems) used to add more elements to the current Simples object
<static>	Simples.fn.addClass(className) to add the specified className to the elements on the Simples object with the specified className
<static>	Simples.fn.animate(action, css, opts) Used to create animations off the elements in the instance of the Simples object
<static>	Simples.fn.animations(action) From the instance of the Simples object used to bridge to the Simples.Animation functionality
<static>	Simples.fn.attr(name, value) to read / write the given attribute to the elements on the Simples object
<static>	Simples.fn.bind(type, callback) to add the event from the elements on the Simples object
<static>	Simples.fn.css(name, value) Used to read the current style attribute or set the current style attribute
<static>	Simples.fn.data(key, value) Simples( '*' ).data: for the elements on the Simples object you can save data to the elements dataset where a simple string or read data off of the element, Simples.data for more information
<static>	Simples.fn.each(callback) To loop over each item in the Simples object
<static>	Simples.fn.filter(testFn) To filter the selected elements on the Simples object
<static>	Simples.fn.find(selector) used to find elements off of the elements currently on the Simples object
<static>	Simples.fn.hasClass(className) to determine whether any of the elements on the Simples object has the specified className
<static>	Simples.fn.html(location, html) to read or write to the dom basd on the elements on the Simples object
<static>	Simples.fn.makeArray() convert the current Simples object into an Array
<static>	Simples.fn.offset(options) To set or retrieve the offset of the selected elements on the Simples object
<static>	Simples.fn.offsetParent() To return the same object with the offsetParents added in place of the selected elements
<static>	Simples.fn.position(name, val) To retrieve or set the scrollTop / scrollLeft elements on the simples object
<static>	Simples.fn.removeClass(className) to remove the specified className to the elements on the Simples object with the specified className
<static>	Simples.fn.scroll(name, val) To retrieve or set the scrollTop / scrollLeft elements on the simples object, if no value is provided the first element has the value return
<static>	Simples.fn.slice(i, len) to return a subset of the selected elements
<static>	Simples.fn.style(type, extra) Used to read the current computed style of the first element or write through this.css the style atttribute, see Simples.getStyle
<static>	Simples.fn.traverse(name) to select a new set of elements off of the elements in the Simples object
<static>	Simples.fn.trigger(type, data) to trigger an event on the elements on the Simples object
<static>	Simples.fn.unbind(type, callback) to remove the event from the elements on the Simples object

---

---

Parameters:

{Elements} elems

An array or Simples object of elements to concatenate to the current simples Object

---

Parameters:

className

---

Parameters:

action

{String} the name of the action to be performed, excluding create && _step

css

{Object} CSS to use in animation, final position

opts

{Object}

opts.callback

{Function} when animation complete

opts.tween

{Function} tween to use when animating

opts.duration

{Object} the time to elapse during animation

---

Parameters:

action

{String} the name of the action to be performed - stop, start, reset, reverse; this is excluding create && _step

---

Parameters:

{String} name

the name of the attribute

{String} value

the value to specify, if undefined will read the attribute, if null will remove the attribute, else will add the value as a string

---

Parameters:

{String} type

the type of event to bind i.e. click, custom, etc

{Function} callback

the callback to bind, false can be specified to have a return false callback

---

Parameters:

{String} name

of the attribute to set

{Number|String} value

to be set either a pure number 12 or string with the 12px

---

Parameters:

{String} key

the name of the dataset to work with

{All} value

the value to write to the dataset

Returns:

{Simples|All} returns Simples object for write and delete and the value for read

---

Parameters:

{Function} callback

The function to call with each item, this is current item, arguments[ item, index, object ]

---

Parameters:

{Function} testFn

The function to call with each item, this is current item, arguments[ item, index, object ], need to return true from callback to retain element all other return values will remove the element

---

Parameters:

{String} selector

Selector string to find elements

---

Parameters:

className

Returns:

{Boolean} indicating whether className is on elements of Simples object

---

Parameters:

{String} location

to specify how to return the dom options are desctructive: [remove, empty, outer, text, inner/undefined ], non-destructive: [top, bottom, unwrap, before, after, wrap ]

{String|Elements} html

the string or Elements to put into the dom, if not specfied where location is [ outer, text, inner/undefined ] will read

Returns:

{Simples|String} if writing to the dom will return this, else will return string of dom

---

---

Parameters:

{Object} options

object with top and / or left specified to set the offset

Returns:

{Number|Simples} the value of the offset or Simples object

---

---

Parameters:

{String} name

'top' or 'left'

{Number} val

the value to set the offset to

Returns:

{Number} the value of the scrollTop / scrollLeft

---

Parameters:

className

---

Parameters:

{String} name

'top' or 'left'

{Number} val

the value to set the offset to

Returns:

{Number|Simples} the value of the scrollTop / scrollLeft or Simples object

---

Parameters:

i

len

---

Parameters:

{String} type

the computed style attribute to read

{Boolean} extra

whether to include extra

---

Parameters:

name

---

Parameters:

{String} type

the type of event to trigger i.e. click, custom, etc

{Any} data

the data to attach to the event

---

Parameters:

{String} type

the type of event to unbind i.e. click, custom, etc, if no type is specifed then all events are unbound

{Function} callback

the callback to unbind, if not specified will unbind all the callbacks to this event

---