THE WORLD'S LARGEST WEB DEVELOPER SITE

jQuery prop() Method

❮ jQuery HTML/CSS Methods

Example

Add and remove a property named "color":

$("button").click(function(){
  var $x = $("div");
  $x.prop("color", "FF0000");
  $x.append("The color property: " + $x.prop("color"));
  $x.removeProp("color");
});
Try it Yourself »

Definition and Usage

The prop() method sets or returns properties and values of the selected elements.

When this method is used to return the property value, it returns the value of the FIRST matched element.

When this method is used to set property values, it sets one or more property/value pairs for the set of matched elements.

Note: The prop() method should be used to retrieve property values, e.g. DOM properties (like tagName, nodeName, defaultChecked) or your own custom made properties.

Tip: To retrieve HTML attributes, use the attr() method instead.

Tip: To remove a property use the removeProp() method.


Syntax

Return the value of a property:

$(selector).prop(property)

Set the property and value:

$(selector).prop(property,value)

Set property and value using a function:

$(selector).prop(property,function(index,currentvalue))

Set multiple properties and values:

$(selector).prop({property:value, property:value,...})

Parameter Description
property Specifies the name of the property
value Specifies the value of the property
function(index,currentvalue) Specifies a function that returns the property value to set
  • index - Receives the index position of the element in the set
  • currentvalue - Receives the current property value of selected elements

Try it Yourself - Examples

Difference between prop() and attr()
prop() and attr() might return different values. This example shows the differences when used to return the "checked" status of a checkbox.


❮ jQuery HTML/CSS Methods