* @name attr
* @type Object
* @param String name The name of the property to access.
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
* @name attr
* @type jQuery
* @param Map properties Key/value pairs to set as object properties.
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
* Set a single property to a value, on all matched elements.
*
+ * Can compute values provided as ${formula}, see second example.
+ *
* Note that you can't set the name property of input elements in IE.
* Use $(html) or .append(html) or .html(html) to create elements
* on the fly including the name property.
* @result <img src="test.jpg"/>
* @desc Sets src attribute to all images.
*
+ * @example $("img").attr("title", "${this.src}");
+ * @before <img src="test.jpg" />
+ * @result <img src="test.jpg" title="test.jpg" />
+ * @desc Sets title attribute from src attribute, a shortcut for attr(String,Function)
+ *
* @name attr
* @type jQuery
* @param String key The name of the property to set.
* @param Object value The value to set the property to.
- * @cat DOM
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set a single property to a computed value, on all matched elements.
+ *
+ * Instead of a value, a function is provided, that computes the value.
+ *
+ * @example $("img").attr("title", function() { return this.src });
+ * @before <img src="test.jpg" />
+ * @result <img src="test.jpg" title="test.jpg" />
+ * @desc Sets title attribute from src attribute.
+ *
+ * @name attr
+ * @type jQuery
+ * @param String key The name of the property to set.
+ * @param Function value A function returning the value to set.
+ * @cat DOM/Attributes
*/
attr: function( key, value, type ) {
// Check to see if we're setting style values
for ( var prop in key )
jQuery.attr(
type ? this.style : this,
- prop, key[prop]
+ prop, jQuery.parseSetter(key[prop])
);
// See if we're setting a single key/value style
- else
+ else {
+ // convert ${this.property} to function returnung that property
jQuery.attr(
type ? this.style : this,
- key, value
+ key, jQuery.parseSetter(value)
);
+ }
}) :
// Look for the case where we're accessing a style value
*
* @name text
* @type String
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
- * Set the text contents of all matched elements. This has the same
- * effect as html().
+ * Set the text contents of all matched elements.
+ *
+ * Similar to html(), but escapes HTML (replace "<" and ">" with their
+ * HTML entities.
+ *
+ * If stripTags argument is set to true, HTML is stripped.
+ *
+ * @example $("p").text("<b>Some</b> new text.");
+ * @before <p>Test Paragraph.</p>
+ * @result <p><b>Some</b> new text.</p>
+ * @desc Sets the text of all paragraphs.
*
- * @example $("p").text("Some new text.");
+ * @example $("p").text("<b>Some</b> new text.", true);
* @before <p>Test Paragraph.</p>
* @result <p>Some new text.</p>
* @desc Sets the text of all paragraphs.
* @name text
* @type String
* @param String val The text value to set the contents of the element to.
- * @cat DOM
+ * @param Boolean stripTags (optional) Wheather to strip or only escape tags
+ * @cat DOM/Attributes
*/
- text: function(e) {
- // A surprisingly high number of people expect the
- // .text() method to do this, so lets do it!
+ text: function(e, stripTags) {
if ( typeof e == "string" )
- return this.html( e );
+ return this.html( stripTags ? e.replace(/<\/?[^>]+>/gi, '') : e.replace(/</g, "<").replace(/>/g, ">") );
e = e || this;
var t = "";
* @example $("p").find("span").end();
* @before <p><span>Hello</span>, how are you?</p>
* @result [ <p>...</p> ]
- * desc Selects all paragraphs, finds span elements inside these, and reverts the
+ * @desc Selects all paragraphs, finds span elements inside these, and reverts the
* selection back to the paragraphs.
*
* @name end
* @param Object prop1 The object that will be merged into the first.
* @param Object propN (optional) More objects to merge into the first
* @type Object
- * @cat Javascript
+ * @cat JavaScript
*/
jQuery.extend = jQuery.fn.extend = function() {
// copy reference to target object
* using the 'jQuery' variable. For example, where you used to do
* $("div p"), you now must do jQuery("div p").
*
- * @example $.noConflict();
+ * @example jQuery.noConflict();
+ * // Do something with jQuery
+ * jQuery("div p").hide();
+ * // Do something with another library's $()
+ * $("content").style.display = 'none';
* @desc Maps the original object that was referenced by $ back to $
*
- * @example $.noConflict();
+ * @example jQuery.noConflict();
* (function($) {
* $(function() {
* // more code using $ as alias to jQuery
* });
* })(jQuery);
- * // other code using $ as an alias to the original implementation (not jQuery)
+ * // other code using $ as an alias to the other library
* @desc Reverts the $ alias and then creates and executes a
* function to provide the $ as a jQuery alias inside the functions
* scope. Inside the function the original $ object is not available.
* This works well for most plugins that don't rely on any other library.
*
*
- * @name noConflict
+ * @name $.noConflict
* @type undefined
* @cat Core
*/
noConflict: function() {
- if(jQuery._$)
+ if ( jQuery._$ )
$ = jQuery._$;
},
* as $().each() - which is used to iterate, exclusively, over a jQuery
* object. This function can be used to iterate over anything.
*
- * @example $.each( [0,1,2], function(i){
- * alert( "Item #" + i + ": " + this );
+ * The callback has two arguments:the key (objects) or index (arrays) as first
+ * the first, and the value as the second.
+ *
+ * @example $.each( [0,1,2], function(i, n){
+ * alert( "Item #" + i + ": " + n );
* });
- * @desc Iterates over the items in an array, accessing both the current item and its index.
+ * @desc This is an example of iterating over the items in an array,
+ * accessing both the current item and its index.
*
- * @example $.each( { name: "John", lang: "JS" }, function(i){
- * alert( "Name: " + i + ", Value: " + this );
+ * @example $.each( { name: "John", lang: "JS" }, function(i, n){
+ * alert( "Name: " + i + ", Value: " + n );
* });
- * @desc Iterates over the properties in an Object, accessing both the current item and its key.
+ *
+ * @desc This is an example of iterating over the properties in an
+ * Object, accessing both the current item and its key.
*
* @name $.each
* @param Object obj The object, or array, to iterate over.
* @param Function fn The function that will be executed on every object.
* @type Object
- * @cat Javascript
+ * @cat JavaScript
*/
// args is for internal usage only
each: function( obj, fn, args ) {
return r;
},
+ parseSetter: function(value) {
+ if( typeof value == "string" && value.charAt(0) == "$" ) {
+ var m = value.match(/{(.*)}$/);
+ if ( m && m[1] ) {
+ value = new Function( "return " + m[1] );
+ }
+ }
+ return value;
+ },
+
attr: function(elem, name, value){
var fix = {
"for": "htmlFor",
selected: "selected"
};
+ // get value if a function is provided
+ if ( value && typeof value == "function" ) {
+ value = value.apply( elem );
+ }
+
// IE actually uses filters for opacity ... elem is actually elem.style
if ( name == "opacity" && jQuery.browser.msie && value != undefined ) {
// IE has trouble with opacity if it does not have layout
* @name $.trim
* @type String
* @param String str The string to trim.
- * @cat Javascript
+ * @cat JavaScript
*/
trim: function(t){
return t.replace(/^\s+|\s+$/g, "");
* @type Array
* @param Array first The first array to merge.
* @param Array second The second array to merge.
- * @cat Javascript
+ * @cat JavaScript
*/
merge: function(first, second) {
var r = [].slice.call( first, 0 );
* @param Array array The Array to find items in.
* @param Function fn The function to process each item against.
* @param Boolean inv Invert the selection - select the opposite of the function.
- * @cat Javascript
+ * @cat JavaScript
*/
grep: function(elems, fn, inv) {
// If a string is passed in for the function, make a function
* @type Array
* @param Array array The Array to translate.
* @param Function fn The function to process each item against.
- * @cat Javascript
+ * @cat JavaScript
*/
map: function(elems, fn) {
// If a string is passed in for the function, make a function
}
}
- var r = [ result[0] ];
+ var r = result.length ? [ result[0] ] : [];
check: for ( var i = 1, rl = result.length; i < rl; i++ ) {
for ( var j = 0; j < i; j++ )
* @property
* @name $.browser
* @type Boolean
- * @cat Javascript
+ * @cat JavaScript
*/
/*
* @property
* @name $.boxModel
* @type Boolean
- * @cat Javascript
+ * @cat JavaScript
*/
new function() {
var b = navigator.userAgent.toLowerCase();
* @name removeAttr
* @type jQuery
* @param String name The name of the attribute to remove.
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
* @name addClass
* @type jQuery
* @param String class A CSS class to add to the elements
- * @cat DOM
+ * @cat DOM/Attributes
* @see removeClass(String)
*/
* @name removeClass
* @type jQuery
* @param String class (optional) A CSS class to remove from the elements
- * @cat DOM
+ * @cat DOM/Attributes
* @see addClass(String)
*/
* @name toggleClass
* @type jQuery
* @param String class A CSS class with which to toggle the elements
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
jQuery.fn[ n ] = function(num,fn) {
return this.filter( ":" + n + "(" + num + ")", fn );
};
-});
\ No newline at end of file
+});
git.asbjorn.biz / jquery.git / blobdiff