outerWidth: document method as a setter

arthurvr · arthurvr · commit 80d53f0433fa · 2015-02-10T07:04:14.000+01:00
Fixes jquerygh-98 Closes jquerygh-648
diff --git a/entries/outerWidth.xml b/entries/outerWidth.xml
@@ -1,4 +1,6 @@
 <?xml version="1.0"?>
+<entries>
+  <desc>Get the current computed width for the first element in the set of matched elements, including padding and border.</desc>
 <entry type="method" name="outerWidth" return="Number">
   <title>.outerWidth()</title>
   <signature>
@@ -42,3 +44,62 @@ $( "p:last" ).text(
   <category slug="manipulation/style-properties"/>
   <category slug="version/1.2.6"/>
 </entry>
+<entry type="method" name="outerWidth" return="jQuery">
+  <signature>
+    <added>1.8.0</added>
+    <argument name="value">
+      <type name="String"/>
+      <type name="Number"/>
+      <desc>A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string).</desc>
+    </argument>
+  </signature>
+  <signature>
+    <added>1.8.0</added>
+    <argument name="function(index, width)" type="Function">
+      <desc>A function returning the outer width to set. Receives the index position of the element in the set and the old outer width as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
+    </argument>
+  </signature>
+  <desc>Set the CSS outer width of each element in the set of matched elements.</desc>
+  <longdesc>
+    <p>When calling <code>.outerWidth(value)</code>, the value can be either a string (number and unit) or a number. If only a number is provided for the value, jQuery assumes a pixel unit. If a string is provided, however, any valid CSS measurement may be used (such as <code>100px</code>, <code>50%</code>, or <code>auto</code>).</p>
+  </longdesc>
+  
+  <example>
+    <desc>Change the outer width of each div the first time it is clicked (and change its color).</desc>
+    <code><![CDATA[
+var modWidth = 60;
+$( "div" ).one( "click", function() {
+  $( this ).outerWidth( modWidth ).addClass( "mod" );
+  modWidth -= 8;
+});
+]]></code>
+    <css><![CDATA[
+  div {
+    width: 60px;
+    padding: 10px;
+    height: 50px;
+    float: left;
+    margin: 5px;
+    background: red;
+    cursor: pointer;
+  }
+  .mod {
+    background: blue;
+    cursor: default;
+  }
+]]></css>
+    <html><![CDATA[
+<div>d</div>
+<div>d</div>
+<div>d</div>
+<div>d</div>
+<div>d</div>
+]]></html>
+  </example>
+  
+  <category slug="css"/>
+  <category slug="dimensions"/>
+  <category slug="manipulation/style-properties"/>
+  <category slug="version/1.8"/>
+</entry>
+</entries>
