[Summary view] [Print] [Text view]

   1  
   2  <ul class="UIAPIPlugin-toc">
   3  <li><a href="#overview">Overview</a></li>
   4  <li><a href="#options">Arguments</a></li>
   5  </ul>
   6  <div class="UIAPIPlugin">
   7    <h1>jQuery UI effect</h1>
   8    <div id="overview">
   9      <h2 class="top-header">Overview</h2>
  10      <div id="overview-main">
  11          <div class="editsection" style="float:right;margin-left:5px;">[<a href="http://docs.jquery.com/action/edit/UI/Effects/effect?section=1" title="Edit section: effect( effect, [options], [speed], [callback] )">edit</a>]</div><a name="effect.28_effect.2C_.5Boptions.5D.2C_.5Bspeed.5D.2C_.5Bcallback.5D_.29"></a><h3>effect( effect, <span class="optional">[</span>options<span class="optional">]</span>, <span class="optional">[</span>speed<span class="optional">]</span>, <span class="optional">[</span>callback<span class="optional">]</span> )</h3>
  12  <p>Uses a specific effect on an element (without the show/hide logic).</p>
  13      </div>
  14      <div id="overview-dependencies">
  15          <h3>Dependencies</h3>
  16          <ul>
  17  <li>Effects Core</li>
  18  </ul>
  19      </div>
  20      <div id="overview-example">
  21          <h3>Example</h3>
  22          <div id="overview-example" class="example">
  23  <ul><li><a href="#demo"><span>Demo</span></a></li><li><a href="#source"><span>View Source</span></a></li></ul>
  24  <p><div id="demo" class="tabs-container" rel="170">
  25  Apply the effect explode if you click on the element.<br />
  26  </p>
  27  <pre>$(&quot;p&quot;).<a href="http://docs.jquery.com/Events/click" title="Events/click">click</a>(function () {
  28        $(&quot;div&quot;).<strong class="selflink">effect</strong>(&quot;explode&quot;);
  29      });
  30  </pre>
  31  <p></div><div id="source" class="tabs-container">
  32  </p>
  33  <pre>&lt;!DOCTYPE html&gt;
  34  &lt;html&gt;
  35  &lt;head&gt;
  36    &lt;link type=&quot;text/css&quot; href=&quot;http://jqueryui.com/latest/themes/base/ui.all.css&quot; rel=&quot;stylesheet&quot; /&gt;
  37    &lt;script type=&quot;text/javascript&quot; src=&quot;http://jqueryui.com/latest/jquery-1.3.2.js&quot;&gt;&lt;/script&gt;
  38    &lt;script src=&quot;http://ui.jquery.com/latest/ui/effects.core.js&quot;&gt;&lt;/script&gt;
  39  &lt;script src=&quot;http://ui.jquery.com/latest/ui/effects.explode.js&quot;&gt;&lt;/script&gt;
  40  &lt;style type=&quot;text/css&quot;&gt;
  41    div { margin: 0 auto; width: 100px; height: 80px; background: blue; position: relative; }
  42  &lt;/style&gt;
  43    &lt;script type="text/javascript"&gt;
  44    $(document).ready(function(){
  45      $(&quot;p&quot;).<a href="http://docs.jquery.com/Events/click" title="Events/click">click</a>(function () {
  46        $(&quot;div&quot;).<strong class="selflink">effect</strong>(&quot;explode&quot;);
  47      });
  48    });
  49    &lt;/script&gt;
  50  &lt;/head&gt;
  51  &lt;body style="font-size:62.5%;"&gt;
  52    
  53  &lt;p&gt;Click me&lt;/p&gt;&lt;div&gt;&lt;/div&gt;
  54  
  55  &lt;/body&gt;
  56  &lt;/html&gt;
  57  </pre>
  58  <p></div>
  59  </p><p></div>
  60      </div>
  61    </div>
  62    <div id="options">
  63      <h2 class="top-header">Arguments</h2>
  64      <ul class="options-list">
  65        
  66  <li class="option" id="option-effect">
  67    <div class="option-header">
  68      <h3 class="option-name"><a href="#option-effect">effect</a></h3>
  69      <dl>
  70        <dt class="option-type-label">Type:</dt>
  71          <dd class="option-type">String</dd>
  72        
  73      </dl>
  74    </div>
  75    <div class="option-description">
  76      <p>The effect to be used. Possible values: 'blind', 'bounce', 'clip', 'drop', 'explode', 'fold', 'highlight', 'puff', 'pulsate', 'scale', 'shake', 'size', 'slide', 'transfer'.</p>
  77    </div>
  78  </li>
  79  
  80  
  81  <li class="option" id="option-options">
  82    <div class="option-header">
  83      <h3 class="option-name"><a href="#option-options">options</a></h3>
  84      <dl>
  85        <dt class="option-type-label">Type:</dt>
  86          <dd class="option-type">Hash</dd>
  87        
  88        <dt class="option-optional-label">Optional</dt>
  89        
  90      </dl>
  91    </div>
  92    <div class="option-description">
  93      <p>A object/hash including specific options for the effect.</p>
  94    </div>
  95  </li>
  96  
  97  
  98  <li class="option" id="option-speed">
  99    <div class="option-header">
 100      <h3 class="option-name"><a href="#option-speed">speed</a></h3>
 101      <dl>
 102        <dt class="option-type-label">Type:</dt>
 103          <dd class="option-type">String, Number</dd>
 104        
 105        <dt class="option-optional-label">Optional</dt>
 106        
 107      </dl>
 108    </div>
 109    <div class="option-description">
 110      <p>A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).</p>
 111    </div>
 112  </li>
 113  
 114  
 115  <li class="option" id="option-callback">
 116    <div class="option-header">
 117      <h3 class="option-name"><a href="#option-callback">callback</a></h3>
 118      <dl>
 119        <dt class="option-type-label">Type:</dt>
 120          <dd class="option-type">Function</dd>
 121        
 122        <dt class="option-optional-label">Optional</dt>
 123        
 124      </dl>
 125    </div>
 126    <div class="option-description">
 127      <p>A function that is called after the effect is completed.</p>
 128    </div>
 129  </li>
 130  
 131      </ul>
 132    </div>
 133  </div>
 134  
 135  </p><!-- 
 136  Pre-expand include size: 6199 bytes
 137  Post-expand include size: 8618 bytes
 138  Template argument size: 5418 bytes
 139  Maximum: 2097152 bytes
 140  -->
 141  
 142  <!-- Saved in parser cache with key jqdocs_docs:pcache:idhash:2612-1!1!0!!en!2 and timestamp 20090603114134 -->