Skip to content

Commit 3f18aa1

Browse files
committed
1 parent b8c6dc3 commit 3f18aa1

19 files changed

+87
-44
lines changed

Docs/Class/Class.Extras.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ Class: Options {#Options}
327327

328328
A Utility Class. Its methods can be implemented with [Class:implement][] into any [Class][].
329329
Used to automate the setting of a Class instance's options.
330-
Will also add Class [Events](#Events) when the option property begins with 'on' and is followed by a capital letter (e.g. 'onComplete' adds a 'complete' event).
330+
Will also add Class [Events](#Events) when the option property begins with 'on' and is followed by a capital letter (e.g. 'onComplete' adds a 'complete' event). You will need to call this.setOptions() for this to have an effect, however.
331331

332332
### Syntax:
333333

Docs/Core/Core.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,7 @@ Returns the type of object that matches the element passed in.
417417
* 'collection' - (*string*) If object is a native htmlelements collection, such as childNodes, getElementsByTagName, etc.
418418
* 'window' - (*string*) If object is the window object.
419419
* 'document' - (*string*) If object is the document object.
420+
* 'event' - (*string*) If object is an event.
420421
* false - (*boolean*) If object is undefined, null, NaN or none of the above.
421422

422423
### Example:

Docs/Element/Element.Dimensions.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ Native: Element {#Element}
33

44
Custom Native to allow all of its methods to be used with any DOM element via the dollar function [$][].
55

6-
### Note:
6+
### Notes:
77

8-
These methods don't take into consideration the body element margins and borders.
9-
If you need margin/borders on the body, consider adding a wrapper div, but always reset the margin and borders of body to 0.
8+
* These methods don't take into consideration the body element margins and borders. If you need margin/borders on the body, consider adding a wrapper div, but always reset the margin and borders of body to 0.
9+
* If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
1010

1111
### Credits:
1212

@@ -59,7 +59,9 @@ The following method is also available on the Window object.
5959
var size = myElement.getSize();
6060
alert("The element is "+size.x+" pixels wide and "+size.y+"pixels high.");
6161

62+
### Note:
6263

64+
If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
6365

6466

6567
Element Method: getScrollSize {#Element:getScrollSize}
@@ -85,6 +87,9 @@ The following method is also available on the Window object.
8587

8688
- [MDC Element:scrollLeft][], [MDC Element:scrollTop][], [MDC Element:offsetWidth][], [MDC Element:offsetHeight][], [MDC Element:scrollWidth][], [MDC Element:scrollHeight][]
8789

90+
### Note:
91+
92+
If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
8893

8994

9095
Element Method: getScroll {#Element:getScroll}
@@ -106,6 +111,9 @@ The following method is also available on the Window object.
106111
var scroll = $('myElement').getScroll();
107112
alert('My element is scrolled down ' + scroll.y + 'px'); //alerts 'My element is scrolled down to 620px'
108113

114+
### Note:
115+
116+
If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
109117

110118
Element Method: getPosition {#Element:getPosition}
111119
--------------------------------------------------
@@ -132,6 +140,10 @@ relative - (Element, defaults to the document) If set, the position will be rela
132140

133141
- [QuirksMode: Find position](http://www.quirksmode.org/js/findpos.html)
134142

143+
### Note:
144+
145+
If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
146+
135147
Element Method: setPosition {#Element:setPosition}
136148
--------------------------------------------------
137149

@@ -189,6 +201,9 @@ relative - (*element*, optional) if set, the position will be relative to this e
189201

190202
[Element:getPosition](#Element:getPosition)
191203

204+
### Note:
205+
206+
If you need to measure the properties of elements that are not displayed (either their display style is none or one of their parents display style is none), you will need to use [Element.measure][] to expose it.
192207

193208
Element Method: getOffsetParent {#Element:getOffsetParent}
194209
----------------------------------------------------------
@@ -209,4 +224,5 @@ Returns the parent of the element that is positioned, if there is one.
209224
[MDC Element:offsetWidth]: http://developer.mozilla.org/en/docs/DOM:element.offsetWidth
210225
[MDC Element:offsetHeight]: http://developer.mozilla.org/en/docs/DOM:element.offsetHeight
211226
[MDC Element:scrollWidth]: http://developer.mozilla.org/en/docs/DOM:element.scrollWidth
212-
[MDC Element:scrollHeight]: http://developer.mozilla.org/en/docs/DOM:element.scrollHeight
227+
[MDC Element:scrollHeight]: http://developer.mozilla.org/en/docs/DOM:element.scrollHeight
228+
[Element.measure]: /more/Element/Element.Measure

Docs/Element/Element.Event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,4 +322,4 @@ This event fires when the mouse wheel is rotated;
322322
[Function]: /core/Native/Function
323323
[Function:bind]: /core/Native/Function/#Function:bind
324324
[Function:pass]: /core/Native/Function/#Function:pass
325-
[Function:delay]: /core/Native/Function/#Function:delay
325+
[Function:delay]: /core/Native/Function/#Function:delay

Docs/Element/Element.Style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,4 +119,4 @@ Returns an object of styles of the Element for each argument passed in.
119119

120120
[$]: /core/Element/Element/#dollar
121121
[Function]: /core/Native/Function
122-
[Element:getStyle]: #Element:getStyle
122+
[Element:getStyle]: #Element:getStyle

Docs/Element/Element.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -647,7 +647,7 @@ A text node will be created inside this Element, in either the top or bottom pos
647647
### Arguments:
648648

649649
1. text - (*string*) The text to append.
650-
1. where - (*string*, optional: default 'bottom') The position to inject the text to.
650+
1. where - (*string*, optional: default 'bottom') The position to inject the text to. Values accepted are 'top', 'bottom', 'before' and 'after'.
651651

652652
### Returns:
653653

Docs/Fx/Fx.CSS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ Has no public methods.
99

1010
[Fx.Tween]: /core/Fx/Fx.Tween
1111
[Fx.Morph]: /core/Fx/Fx.Morph
12-
[Fx.Elements]: /more/Fx/Fx.Elements
12+
[Fx.Elements]: /more/Fx/Fx.Elements

Docs/Fx/Fx.Transitions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ A collection of tweening transitions for use with the [Fx][] classes.
1515

1616
### Examples:
1717

18-
//Elastic.easeOut with default values:
19-
var myFx = $('myElement').effect('margin', {transition: Fx.Transitions.Elastic.easeOut});
18+
$('myElement').set('tween', {transition: Fx.Transitions.Elastic.easeOut});
19+
$('myElement').tween('margin-top', 100);
2020

2121
### See also:
2222

@@ -144,4 +144,4 @@ Returns an [Fx][] transition function with 'easeIn', 'easeOut', and 'easeInOut'
144144
[Sine]: ../Docs/assets/images/Sine.png
145145
[Back]: ../Docs/assets/images/Back.png
146146
[Bounce]: ../Docs/assets/images/Bounce.png
147-
[Elastic]: ../Docs/assets/images/Elastic.png
147+
[Elastic]: ../Docs/assets/images/Elastic.png

Docs/Native/Array.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ Accepts an object of key / function pairs to assign values.
320320

321321
var el = document.createElement('div');
322322
var arr2 = [100, 'Hello', {foo: 'bar'}, el, false];
323-
arr2.link({myNumber: Type.isNumber, myElement: Type.isElement, myObject: Type.isObject, myString: Type.isString, myBoolean: $defined});
323+
arr2.link({myNumber: Number.type, myElement: Element.type, myObject: Object.type, myString: String.type, myBoolean: $defined});
324324
//returns {myNumber: 100, myElement: el, myObject: {foo: 'bar'}, myString: 'Hello', myBoolean: false}
325325

326326

@@ -627,15 +627,15 @@ Creates a copy of an Array. Useful for applying the Array prototypes to iterable
627627

628628
[Array]: /core/Native/Array
629629
[Function:bind]: /core/Native/Function/#Function:bind
630-
[MDC Array]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array
631-
[MDC Array:every]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:every
632-
[MDC Array:filter]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:filter
633-
[MDC Array:indexOf]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:indexOf
634-
[MDC Array:map]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:map
635-
[MDC Array:some]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:some
636-
[MDC Array:forEach]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:forEach
637-
[Array:every]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:every
638-
[Array:filter]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:filter
639-
[Array:indexOf]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:indexOf
640-
[Array:map]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:map
641-
[Array:some]: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:some
630+
[MDC Array]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array
631+
[MDC Array:every]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/every
632+
[MDC Array:filter]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter
633+
[MDC Array:indexOf]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/indexOf
634+
[MDC Array:map]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/map
635+
[MDC Array:some]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/some
636+
[MDC Array:forEach]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/forEach
637+
[Array:every]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/every
638+
[Array:filter]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter
639+
[Array:indexOf]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/indexOf
640+
[Array:map]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/map
641+
[Array:some]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/some

Docs/Native/Event.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Event Method: constructor {#Event:constructor}
1313

1414
### Arguments:
1515

16-
1. event - (*event*) An HTMLEvent Object.
16+
1. event - (*event*, required) An HTMLEvent Object.
1717
2. win - (*window*, optional: defaults to window) The context of the event.
1818

1919
#### Properties:
@@ -177,4 +177,4 @@ Additional Event key codes can be added by adding properties to the Event.Keys H
177177
[Function]: /core/Native/Function
178178
[Function:bind]: /core/Native/Function/#Function:bind
179179
[Function:pass]: /core/Native/Function/#Function:pass
180-
[Function:delay]: /core/Native/Function/#Function:delay
180+
[Function:delay]: /core/Native/Function/#Function:delay

0 commit comments

Comments
 (0)