kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-01 12:42:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1486 from johnnyreilly/master

Browse Source 
jQuery: Added JSDoc for prop / val
This commit is contained in:
John Reilly
2013-12-29 14:25:34 -08:00
parent 58109f1bda 609712265e
commit 51f1dc08ff
2 changed files with 114 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
jquery/jquery-tests.ts
View File

@@ -2309,6 +2309,56 @@ function test_prop() {
var title: string = $('option:selected', this).prop('title');
}
function test_val() {
// Get the value from a dropdown select
$("select.foo option:selected").val();
// Get the value from a dropdown select even easier
$("select.foo").val();
// Get the value from a checked checkbox
$("input:checkbox:checked").val();
// Get the value from a set of radio buttons
$("input:radio[name=bar]:checked").val();
function displayVals() {
var singleValues = $("#single").val();
var multipleValues = $("#multiple").val() || [];
$("p").html("<b>Single:</b> " + singleValues +
" <b>Multiple:</b> " + multipleValues.join(", "));
}
$("select").change(displayVals);
displayVals();
$("input")
.keyup(function () {
var value = $(this).val();
$("p").text(value);
})
.keyup();
$("input:text.items").val(function (index, value) {
return value + " " + this.className;
});
$("button").click(function () {
var text = $(this).text();
$("input").val(text);
});
$("input").on("blur", function () {
$(this).val(function (i, val) {
return val.toUpperCase();
});
});
$("#single").val("Single2");
$("#multiple").val(["Multiple2", "Multiple3"]);
$("input").val(["check1", "check2", "radio1"]);
}
function test_selector() {
var $main = $('#main');

70
jquery/jquery.d.ts vendored
View File

@@ -788,10 +788,46 @@ interface JQuery {
html(htmlContent: (index: number, oldhtml: string) => string): JQuery;
html(obj: JQuery): JQuery;
/**
* Get the value of a property for the first element in the set of matched elements.
*
* @param propertyName The name of the property to get.
*/
prop(propertyName: string): any;
prop(propertyName: string, value: any): JQuery;
prop(map: any): JQuery;
prop(propertyName: string, func: (index: any, oldPropertyValue: any) => any): JQuery;
/**
* Set one or more properties for the set of matched elements.
*
* @param propertyName The name of the property to set.
* @param value A value to set for the property.
*/
prop(propertyName: string, value: string): JQuery;
/**
* Set one or more properties for the set of matched elements.
*
* @param propertyName The name of the property to set.
* @param value A value to set for the property.
*/
prop(propertyName: string, value: number): JQuery;
/**
* Set one or more properties for the set of matched elements.
*
* @param propertyName The name of the property to set.
* @param value A value to set for the property.
*/
prop(propertyName: string, value: boolean): JQuery;
/**
* Set one or more properties for the set of matched elements.
*
* @param properties An object of property-value pairs to set.
*/
prop(properties: Object): JQuery;
/**
* Set one or more properties for the set of matched elements.
*
* @param propertyName The name of the property to set.
* @param func A function returning the value to set. Receives the index position of the element in the set and the old property value as arguments. Within the function, the keyword this refers to the current element.
*/
prop(propertyName: string, func: (index: number, oldPropertyValue: any) => any): JQuery;
/**
* Remove an attribute from each element in the set of matched elements.
@@ -813,6 +849,11 @@ interface JQuery {
*/
removeClass(func: (index: number, className: string) => string): JQuery;
/**
* Remove a property for the set of matched elements.
*
* @param propertyName The name of the property to remove.
*/
removeProp(propertyName: string): JQuery;
/**
@@ -836,11 +877,28 @@ interface JQuery {
*/
toggleClass(func: (index: number, className: string, swtch: boolean) => string, swtch?: boolean): JQuery;
/**
* Get the current value of the first element in the set of matched elements.
*/
val(): any;
val(value: string[]): JQuery;
/**
* Set the value of each element in the set of matched elements.
*
* @param value A string of text or an array of strings corresponding to the value of each matched element to set as selected/checked.
*/
val(value: string): JQuery;
val(value: number): JQuery;
val(func: (index: any, value: any) => any): JQuery;
/**
* Set the value of each element in the set of matched elements.
*
* @param value A string of text or an array of strings corresponding to the value of each matched element to set as selected/checked.
*/
val(value: string[]): JQuery;
/**
* Set the value of each element in the set of matched elements.
*
* @param func A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old value as arguments.
*/
val(func: (index: number, value: any) => any): JQuery;
/**
* Get the value of style properties for the first element in the set of matched elements.