jQuery: offsetWidth, offsetHeight, position JSDoc

removed invalid overloads, added JSDoc, changed position to use
JQueryCoordinates.  Added position test suite.
This commit is contained in:
John Reilly
2014-01-09 13:35:13 +00:00
parent ab4e800afb
commit 40adcdd3ad
2 changed files with 26 additions and 9 deletions
+12 -6
View File
@@ -1802,16 +1802,22 @@ function test_innerWidth() {
function test_outerHeight() {
var p = $("p:first");
$("p:last").text("outerHeight:" + p.outerHeight(true));
p.outerHeight(p.outerHeight() * 2).outerHeight();
p.outerHeight(p.outerHeight() * 2, true).outerHeight();
$("p:last").text(
"outerHeight:" + p.outerHeight() +
" , outerHeight( true ):" + p.outerHeight(true));
}
function test_outerWidth() {
var p = $("p:first");
$("p:last").text("outerWidth:" + p.outerWidth(true));
p.outerWidth(p.outerWidth() * 2).outerWidth();
p.outerWidth(p.outerWidth() * 2, true).outerWidth();
$("p:last").text(
"outerWidth:" + p.outerWidth() +
" , outerWidth( true ):" + p.outerWidth(true));
}
function test_position() {
var p = $("p:first");
var position = p.position();
$("p:last").text("left: " + position.left + ", top: " + position.top);
}
function test_insertAfter() {
+14 -3
View File
@@ -1048,13 +1048,24 @@ interface JQuery {
*/
offset(func: (index: number, coords: JQueryCoordinates) => JQueryCoordinates): JQuery;
/**
* Get the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. Returns an integer (without "px") representation of the value or null if called on an empty set of elements.
*
* @param includeMargin A Boolean indicating whether to include the element's margin in the calculation.
*/
outerHeight(includeMargin?: boolean): number;
outerHeight(value: number, includeMargin?: boolean): JQuery;
/**
* Get the current computed width for the first element in the set of matched elements, including padding and border.
*
* @param includeMargin A Boolean indicating whether to include the element's margin in the calculation.
*/
outerWidth(includeMargin?: boolean): number;
outerWidth(value: number, includeMargin?: boolean): JQuery;
position(): { top: number; left: number; };
/**
* Get the current coordinates of the first element in the set of matched elements, relative to the offset parent.
*/
position(): JQueryCoordinates;
scrollLeft(): number;
scrollLeft(value: number): JQuery;