Permalink
Browse files

Add Links to the new Demos in the Docs + make sure each class has a "…

…ClassName Method: constructor" header

* Fix example in Group (Replaced Ajax with Request)
* Better formatting of events in Slider and Accordion
* Added Turkish to the list of available Locales
  • Loading branch information...
arian committed Jan 15, 2011
1 parent c023a4e commit 8f969cc67ebac3f4b7bcec60347848ebd15c9452
Showing with 276 additions and 149 deletions.
  1. +1 −1 Docs/Class/Events.Pseudos.md
  2. +9 −9 Docs/Drag/Drag.Move.md
  3. +2 −2 Docs/Drag/Drag.md
  4. +32 −29 Docs/Drag/Slider.md
  5. +8 −5 Docs/Drag/Sortables.Delegation.md
  6. +11 −2 Docs/Drag/Sortables.md
  7. +4 −0 Docs/Element/Element.Delegation.md
  8. +3 −0 Docs/Element/Element.Event.Pseudos.md
  9. +2 −2 Docs/Element/Element.Forms.md
  10. +1 −2 Docs/Element/Element.Measure.md
  11. +1 −2 Docs/Element/Element.Pin.md
  12. +2 −2 Docs/Element/Element.Position.md
  13. +1 −2 Docs/Element/Element.Shortcuts.md
  14. +7 −1 Docs/Forms/Form.Request.md
  15. +4 −0 Docs/Forms/Form.Validator.Inline.md
  16. +7 −0 Docs/Forms/Form.Validator.md
  17. +8 −3 Docs/Forms/OverText.md
  18. +22 −18 Docs/Fx/Fx.Accordion.md
  19. +10 −7 Docs/Fx/Fx.Elements.md
  20. +5 −5 Docs/Fx/Fx.Move.md
  21. +17 −13 Docs/Fx/Fx.Reveal.md
  22. +4 −4 Docs/Fx/Fx.Scroll.md
  23. +23 −16 Docs/Fx/Fx.Slide.md
  24. +4 −1 Docs/Fx/Fx.SmoothScroll.md
  25. +8 −6 Docs/Fx/Fx.Sort.md
  26. +4 −0 Docs/Interface/HtmlTable.Select.md
  27. +4 −0 Docs/Interface/HtmlTable.Sort.md
  28. +4 −0 Docs/Interface/HtmlTable.Zebra.md
  29. +3 −0 Docs/Interface/HtmlTable.md
  30. +3 −3 Docs/Interface/Keyboard.md
  31. +4 −0 Docs/Interface/Mask.md
  32. +4 −0 Docs/Interface/Scroller.md
  33. +3 −0 Docs/Interface/Spinner.md
  34. +2 −2 Docs/Interface/Tips.md
  35. +5 −0 Docs/Locale/Date.md
  36. +5 −0 Docs/Locale/Form.Validator.md
  37. +5 −0 Docs/Locale/Number.md
  38. +3 −0 Docs/Request/Request.JSONP.md
  39. +3 −0 Docs/Request/Request.Periodical.md
  40. +7 −5 Docs/Request/Request.Queue.md
  41. +2 −2 Docs/Types/URI.md
  42. +3 −0 Docs/Utilities/Color.md
  43. +9 −3 Docs/Utilities/Group.md
  44. +3 −0 Docs/Utilities/Hash.Cookie.md
  45. +4 −2 Docs/Utilities/IframeShim.md
@@ -3,7 +3,7 @@ Events.Pseudos
Defines the `:once` pseudo event for classes that have implemented the [Events][] class as well as the `definePseudos` method for adding your own.
-Event Pseudos {#Pseudos}
+Pseudo Events {#Pseudos}
========================
Like [Element.Event.Pseudos][] for Elements, you can use pseudos for Class Events.
View
@@ -4,13 +4,20 @@ Class: Drag.Move {#Drag-Move}
An extension to the base Drag class with additional functionality for dragging an Element. Supports snapping and droppables.
Inherits methods, properties, options and events from [Drag][].
+### Demos
+
+* [Drag.Cart](http://mootools.net/demos/?demo=Drag.Cart)
+* [Drag.Drop](http://mootools.net/demos/?demo=Drag.Drop)
+* [Drag.Move](http://mootools.net/demos/?demo=Drag.Move)
+
+
### Note
Drag.Move requires the page to be in [Standards Mode](http://hsivonen.iki.fi/doctype/).
-Drag.Move Method: constructor {#Drag-Move:constructor}
--------------------------------------------------
+Drag.Move Method: constructor
+-----------------------------
### Syntax
@@ -63,18 +70,11 @@ All the base Drag options, plus:
- Drag.Move requires the page to be in [Standards Mode](http://hsivonen.iki.fi/doctype/).
- Drag.Move supports either position absolute or relative. If no position is found, absolute will be set.
-### Demos
-
-* Drag.Cart - <http://mootools.net/demos/?demo=Drag.Cart>
-* Drag.Drop - <http://mootools.net/demos/?demo=Drag.Drop>
-* Drag.Move - <http://mootools.net/demos/?demo=Drag.Move>
-
### See Also
- [Drag][]
-
Drag.Move Method: stop {#Drag-Move:stop}
-------------------------------------------------
View
@@ -8,8 +8,8 @@ Enables the modification of two CSS properties of an Element based on the positi
[Events][], [Chain][], [Options][]
-Drag Method: constructor {#Drag:constructor}
---------------------------------------------
+Drag Method: constructor
+------------------------
### Syntax
View
@@ -3,10 +3,17 @@ Class: Slider {#Slider}
Creates a slider with two elements: a knob and a container.
+### Demo
+
+- [Slider](http://mootools.net/demos/?demo=Slider)
+
### Note
- Slider requires the page to be in [Standards Mode](http://hsivonen.iki.fi/doctype/).
+Slider Method: constructor
+--------------------------
+
### Syntax
var mySlider = new Slider(element, knob[, options]);
@@ -17,7 +24,7 @@ Creates a slider with two elements: a knob and a container.
2. knob - (*element*) The handle element for the slider.
3. options - (*object*) An optional object for customizing the Slider.
-#### Options
+### Options
1. snap - (*boolean*: defaults to false) True if you want the knob to snap to the nearest value.
2. offset - (*number*: defaults to 0) Relative offset for knob position at start.
@@ -27,64 +34,51 @@ Creates a slider with two elements: a knob and a container.
6. mode - (*string*: defaults to horizontal) The type of Slider can be either 'horizontal' or 'vertical' in movement.
6. initialStep - (*number*: defaults to 0) The step the slider will start at.
-### Notes
+### Events
-- Range option allows an array of numbers. Numbers can be negative and positive.
-- If snap is enabled, the width of the bar in which the slider resides must fit an equation for the steps to line up just right at it's end value. The equation is:
+#### change
- (Math.ceil(barWidth/numSteps - knobWidth/numSteps) * numSteps) + knobWidth
+Fires when the Slider's value changes.
-For instance, if you had a bar that is 300px wide and a knob that is 15px wide, and have snap enabled and 10 steps specified, then the bar's width divided by the number of steps (300 / 10 = 30) minus room for the knob (15 / 10 = 1.5) gives you the value of each step (28.5). Slider must round this value, and it rounds up (29). Take this and multiply times the number of steps and you get 290, but there must also be room for the knob, which adds 15, yielding 305. The result is that our knob can't be dragged to the 10th position because there isn't room for it; so it stops at the 9th. This takes a little tweaking in your css. Just add a few pixels until you can drag it all the way (or change the knob width).
-
-
-
-Slider Event: change {#Slider:change}
--------------------------------------
-
-* (*function*) Fires when the Slider's value changes.
-
-### Signature
+##### Signature
onChange(step)
-### Arguments
+##### Arguments
1. step - (*number*) The current step that the Slider is on.
+#### onComplete
-Slider Event: onComplete {#Slider:complete}
--------------------------------------------
-
-* (*function*) Fire when you're done dragging.
+Fire when you're done dragging.
-### Signature
+##### Signature
onComplete(step)
-### Arguments
+##### Arguments
1. step - (*string*) The current step that the Slider is on as a string.
+#### tick
-Slider Event: tick {#Slider:tick}
----------------------------------
-
-* (*function*) Fires when the user scrolls or when the container element is clicked. This Event can be overridden to alter the default tick behavior.
+Fires when the user scrolls or when the container element is clicked. This Event can be overridden to alter the default tick behavior.
-### Signature
+##### Signature
onTick(pos)
-### Arguments
+##### Arguments
1. pos - (*number*) The current position that slider moved to.
-### Notes
+##### Notes
- By default Slider uses the 'tick' event to set the style of the knob to a new position.
+
### Returns
* (*object*) A new Slider instance.
@@ -105,6 +99,15 @@ Slider Event: tick {#Slider:tick}
});
+### Notes
+
+- Range option allows an array of numbers. Numbers can be negative and positive.
+- If snap is enabled, the width of the bar in which the slider resides must fit an equation for the steps to line up just right at it's end value. The equation is:
+
+ (Math.ceil(barWidth/numSteps - knobWidth/numSteps) * numSteps) + knobWidth
+
+For instance, if you had a bar that is 300px wide and a knob that is 15px wide, and have snap enabled and 10 steps specified, then the bar's width divided by the number of steps (300 / 10 = 30) minus room for the knob (15 / 10 = 1.5) gives you the value of each step (28.5). Slider must round this value, and it rounds up (29). Take this and multiply times the number of steps and you get 290, but there must also be room for the knob, which adds 15, yielding 305. The result is that our knob can't be dragged to the 10th position because there isn't room for it; so it stops at the 9th. This takes a little tweaking in your css. Just add a few pixels until you can drag it all the way (or change the knob width).
+
Slider Method: set {#Slider:set}
--------------------------------
@@ -5,7 +5,10 @@ An event delegated interface for drag and drop sorting, Sortables.Delegation is
### Extends:
-[Sortables][]
+* [Sortables][]
+
+Sortables.Delegation Method: constructor
+----------------------------------------
### Syntax:
@@ -32,8 +35,8 @@ All events defined by [Sortables][]
Adding a sortable item is as simple as injecting an element into a list element.
-Sortables Method: addLists {#Sortables-Delegation:addLists}
------------------------------------------------------------
+Sortables.Delegation Method: addLists {#Sortables-Delegation:addLists}
+----------------------------------------------------------------------
Allows one or more entire lists to be added to an existing Sortables instance, allowing sorting between the new and old lists. The relay specified in the instance options will be applied in delegating these lists.
@@ -58,8 +61,8 @@ Allows one or more entire lists to be added to an existing Sortables instance, a
- [Sortables.Delegation:removeLists](#Sortables-Delegation:removeLists)
-Sortables Method: removeLists {#Sortables-Delegation:removeLists}
------------------------------------------------------------------
+Sortables.Delegation Method: removeLists {#Sortables-Delegation:removeLists}
+----------------------------------------------------------------------------
Allows one or more entire lists to be removed from an existing Sortables instance, preventing sorting between the lists.
View
@@ -3,6 +3,15 @@ Class: Sortables {#Sortables}
Creates an interface for drag and drop sorting of a list or lists.
+### Demo
+
+* [Sortables](http://mootools.net/demos/?demo=Sortables)
+
+
+Sortables Method: constructor
+-----------------------------
+
+
### Syntax:
new Sortables(list[, options]);
@@ -20,7 +29,7 @@ Creates an interface for drag and drop sorting of a list or lists.
* handle - (*string*: defaults to *false*) A selector to select an element inside each sortable item to be used as the handle for sorting that item. If no match is found, the element is used as its own handle.
* opacity - (*number*: defaults to *1*) Opacity of the place holding element
* revert - (*mixed*: defaults to *false*) Whether or not to use an effect to slide the element into its final location after sorting. If you pass an object it will be used as additional options for the revert effect.
-* dragOptions - (*object*; defaults to *{}*) The options to apply internally to sortable's Drag.Move instances.
+* dragOptions - (*object*; defaults to *{}*) The options to apply internally to sortable's [Drag.Move][] instances.
### Events:
@@ -273,6 +282,6 @@ If more than one list is being used, all lists will be serialized and returned i
//'3-0=0&3-1=1&3-2=2'
-
+[Drag.Move]: /more/Drag/Drag.Move
[Element]: /core/Elements/Element
[Elements]: /core/Element/Element#Elements
@@ -3,6 +3,10 @@ Type: Element {#Element}
Extends the [Element][] type to include delegations in the addEvent and addEvents methods. It adds the `:relay` pseudo using [Element.Event.Pseudos][].
+### Demo
+
+* [Element.Delegation](http://mootools.net/demos/?demo=Element.Delegation)
+
### Notes
* By delegating events to parent objects you can dramatically increase the efficiency of your pages. Consider the example above. You could attach events to every link on a page - which may be hundreds of DOM elements - or you can delegate the event to the document body, evaluating your code only when the user actually clicks a link (instead of on page load/domready).
@@ -3,6 +3,9 @@ Element.Event.Pseudos {#Pseudos}
Defines a useful pseudo event: `:once` as well as the `definePseudo` method to create your own. See also the `:relay` pseudo in [Element.Delegation][].
+### Demo
+
+* [Element.Event.Pseudos](http://mootools.net/demos/?demo=Element.Event.Pseudos)
Pseudo: once {#Pseudos:once}
----------------------------
@@ -5,8 +5,8 @@ Extends the [Element][] Type to include methods useful in managing inputs.
### Tutorial/Demo
-* [Online Tutorial/Demo][]
-[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/04-element/00-element.forms
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/04-element/00-element.forms)
+
Element Method: tidy {#Element:tidy}
------------------------------------
@@ -4,8 +4,7 @@ The following functions are treated as [Element][] methods.
### Tutorial/Demo
-* [Online Tutorial/Demo][]
-[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/04-element/01-element.measure
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/04-element/01-element.measure)
Element Method: measure {#Element:measure}
@@ -4,8 +4,7 @@ Extends the [Element][] Type to include the *pin* method useful for fixed positi
### Tutorial/Demo
-* [Online Tutorial/Demo][]
-[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/04-element/03-element.pin
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/04-element/03-element.pin)
Element Method: pin {#Element:pin}
@@ -4,8 +4,8 @@ Extends the [Element][] Type with the method *position* which sets the location
### Tutorial/Demo
-* [Online Tutorial/Demo][]
-[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/04-element/04-element.position
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/04-element/04-element.position)
+
Element Method: position {#Element:position}
--------------------------------------------------
@@ -5,8 +5,7 @@ Extends the [Element][] Type with some basic shortcuts (like .hide and .show).
### Tutorial/Demo
-* [Online Tutorial/Demo][]
-[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/04-element/05-element.shortcuts
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/04-element/05-element.shortcuts)
Element Method: isDisplayed {#Element:isDisplayed}
----------------------------------------------
@@ -1,7 +1,13 @@
Class: Form.Request {#Form-Request}
-=========================
+===================================
+
Updates a DOM element with the response from the submission of a form (via Ajax).
+### Demo
+
+* [Enhanced Form](http://mootools.net/demos/?demo=Enhanced-Form)
+
+
### Implements
- [Options][], [Events][], [Class.Occlude][]
@@ -11,6 +11,10 @@ Evaluates an entire form against all the validators that are set up *displaying
* [Options][], [Events][]
+
+Form.Validator.Inline Method: Constructor
+------------------------------------------
+
### Syntax
new Form.Validator.Inline(form[, options]);
@@ -3,10 +3,17 @@ Class: Form.Validator {#Form-Validator}
Evaluates an entire form against all the validators that are set up, firing events when inputs fail validation.
+### Demo
+
+* [Enhanced Form](http://mootools.net/demos/?demo=Enhanced-Form)
+
### Implements
* [Options][], [Events][]
+Form.Validator Method: Constructor
+----------------------------------
+
### Syntax
new Form.Validator(form[, options]);
View
@@ -3,15 +3,20 @@ Class: OverText {#OverText}
Shows text over an input that disappears when the user clicks into it. The text remains hidden if the user adds a value.
-### Tutorial/Demo
+### Tutorial/Demos
-* [Online Tutorial/Demo][]
-[Online Tutorial/Demo]:http://www.clientcide.com/wiki/cnet-libraries/09-forms/05-overtext
+* [Enhanced Form](http://mootools.net/demos/?demo=Enhanced-Form)
+* [Online Tutorial/Demo](http://www.clientcide.com/wiki/cnet-libraries/09-forms/05-overtext)
### Implements
* [Options][], [Events][], [Class.Binds][]
+
+OverText Method: constructor
+-----------------------------
+
+
### Syntax
new OverText(input[, options]);
Oops, something went wrong.

0 comments on commit 8f969cc

Please sign in to comment.