http://karmagination.com/documentation/ 2009-09-11T16:21:36-06:00 http://karmagination.com/documentation/ http://karmagination.com/documentation/lib/images/favicon.ico text/html 2009-06-29T16:55:00-06:00 http://karmagination.com/documentation/adding?rev=1246316100&do=diff It is possible to add additional elements to current set of elements. add( element ) Adds more elements to the current element Parameters: * element <CSS String | HTMLElement | Array> Elements that will be added to current collection. <div id="hi">a</div> <div id="hi2">b</div> <div id="hi3">c</div> text/html 2009-06-22T16:51:23-06:00 http://karmagination.com/documentation/ajax?rev=1245711083&do=diff Abstraction method for XMLHttpRequest Karma.ajax( options ) Options * type: (string) can be 'GET' or 'POST', defaults to 'GET' * url: (string, required) the URL of the document * data: (string) serialized data to be passed the document, defaults to '' * contentType: (string) Sets the content type header. * loading: (function) Runs when the request has started. * success: (function) Runs when the request has successfully completed. * error: (function) Runs when the request has e… text/html 2009-06-29T20:03:46-06:00 http://karmagination.com/documentation/animation?rev=1246327426&do=diff animate( properties, duration, callback, easing, step ) Animates the current elements. Karma(document.body).animate({ scrollTop: 2000, fontSize: '20px' }, 2000, function(){ alert('finished animating'); }); stop( ) Stops the current animation and clears the animation queue. text/html 2009-06-22T01:47:37-06:00 http://karmagination.com/documentation/attributes?rev=1245656857&do=diff The methods described will allow you to change the attributes of the elements. attr( name ) Returns the attribute name's value of the first element. <div title="fun"></div> alert(Karma('div').attr('title')); // fun attr( name, value ) Change the attribute value of the elements. text/html 2009-06-29T17:05:29-06:00 http://karmagination.com/documentation/browser_detection?rev=1246316729&do=diff Karmagination opted to detect browsers not by their user agent string but by their existance of certain objects. Karmagination does not use browser detection internally. Karma.isIE Is true if the current browser is Internet Explorer. Karma.isIE6 Is true if the current browser is Internet Explorer 6. text/html 2009-06-22T13:41:13-06:00 http://karmagination.com/documentation/chaining?rev=1245699673&do=diff Chaining provides caching to the elements that have been selected. end( ) Gets the elements in the previous chain. <div>a</div> <span>b</span> Karma('div'); // div Karma('div').add('span'); // div, span Karma('div').add('span').end(); // div text/html 2009-06-23T00:13:19-06:00 http://karmagination.com/documentation/class?rev=1245737599&do=diff An abstraction to creating Java-like classes in JavaScript. var livingThings = Karma.Class({ constructor: function() {}, getAge: function() { return this.age; } }); var Animal = Karma.Class({ constructor: function(species, age){ this.species = species; this.age = age; }, getSpecies: function() { return this.species; } }); Animal.inherit(livingThings); var bear = new Animal('bear', 10); bear.getSpecies(); // 'bear' bear.getAge(); // 10 Animal.add({ modif… text/html 2009-06-29T16:52:03-06:00 http://karmagination.com/documentation/constructor?rev=1246315923&do=diff The Karmagination constructors are ordered by how processing-intensive they are (during normal usage) with Karma() being the lightest and Karma(selector) being the heaviest. Karma( ) Karma() is an alias for Karma(document). Please view Karma(element) below for more information. text/html 2009-06-29T20:03:58-06:00 http://karmagination.com/documentation/events?rev=1246327438&do=diff Karmagination supports namespaced events but not custom events. on( event, callback ) Binds an event to the element. The event can be namespaced. <div>Hello!</div> Karma('div').on('click.mynamespace', function(e, el){ alert($(el).html()); // alerts Hello! when clicked }); text/html 2009-06-22T17:12:57-06:00 http://karmagination.com/documentation/general?rev=1245712377&do=diff Here are some utilities that are useful when you use Karmagination. Karma.unique( array ) Returns array with unique items. Karma.unique(['a', 'b', 'c', 'a', 'a']); // returns ['a', 'b', 'c'] Karma.makeArray( object ) Converts array-like objects to a true array so array methods will be available ie. splice, slice, push, pop etc. text/html 2009-06-29T16:56:02-06:00 http://karmagination.com/documentation/getters?rev=1246316162&do=diff Sometimes it is necessary to filter out some elements. [ n ] Gets the nth element that are current contained in that instance of Karmagination object. The returned element will lose access to Karmagination's method. <div>One</div> <div>Two</div> <div>Three</div> text/html 2009-06-22T01:43:39-06:00 http://karmagination.com/documentation/iterators?rev=1245656619&do=diff By now you should have realized that the Karmagination is basically an object with a collections of elements. Sometimes it is necessary to iterate though all the elements and do something with them. each( callback ) Iterates and firing a callback through each and every element. Two are arguments are passed to the callback function, the current element and the ith iteration. Returns the Karmagination object. This method is chainable. text/html 2009-06-22T13:33:26-06:00 http://karmagination.com/documentation/manipulate?rev=1245699206&do=diff Using these methods, you can change the contents and order of the DOM tree. html( ) Returns the innerHTML of the first element in Karmagination. <div id="one">Hi</div> alert(Karma('#one').html()); // Hi html( val ) Sets the innerHTML of the elements to val. text/html 2009-06-29T17:10:15-06:00 http://karmagination.com/documentation/selectors?rev=1246317015&do=diff Those familiar with CSS knows how powerful and expressive they can be in selecting elements. Below are the CSS selectors that are supported by Karmagination (Note: Karmagination uses the Sizzle selector engine). Supported CSS selectors Selector Meaning Example * all elements in the current document $('*') E an element of type E $('div') E#myid an E element with ID equal to “myid” $('div#unique') E.myclass an E element with class name equal to “myclass” $('div.current') E[foo] an… text/html 2009-06-22T23:48:53-06:00 http://karmagination.com/documentation/sidebar?rev=1245736133&do=diff Karmagination API * DOM Methods * Constructor * Selectors * Adding * Filters * Iterators * Traverse * Attributes * Manipulate * Styles * Events * Animation * Utilities * General * Type Detection * Browser Detection * Class * Ajax text/html 2009-06-22T13:36:36-06:00 http://karmagination.com/documentation/styles?rev=1245699396&do=diff For performance reasons, Karmagination will not be camel-casing the CSS properties. If you with to use these methods make sure to do them yourself, ie. zIndex (not z-index), backgroundColor (not background-color). css( name ) Get the current value of the style for the first element. text/html 2009-06-22T17:09:02-06:00 http://karmagination.com/documentation/traversing?rev=1245712142&do=diff This section discusses methods that will enable you to walk the DOM, from selecting the parent to selecting the nodes that are next to the current element. end( ) Gets the elements in the previous chain. <div>a</div> <span>b</span> Karma('div'); // div Karma('div').add('span'); // div, span Karma('div').add('span').end(); // div text/html 2009-09-08T14:57:23-06:00 http://karmagination.com/documentation/type_detection?rev=1252443443&do=diff Karmagination provides a way to detect data types reliably as the native built-in typeof method have quite a few quirks. Karma.isKarma( data ) Returns true if the object is an instance of Karmagination, false otherwise. var a = Karma(); Karma.isKarma(a); // true