Project

General

Profile

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 href=&quot;http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/base/jquery-ui.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot;/&gt;
37
  &lt;script src=&quot;http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js&quot;&gt;&lt;/script&gt;
38
  &lt;script src=&quot;http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/jquery-ui.min.js&quot;&gt;&lt;/script&gt;
39
  &lt;script src=&quot;http://ui.jquery.com/latest/ui/effects.core.js&quot;&gt;&lt;/script&gt;
40
&lt;script src=&quot;http://ui.jquery.com/latest/ui/effects.explode.js&quot;&gt;&lt;/script&gt;
41
&lt;style type=&quot;text/css&quot;&gt;
42
  div { margin: 0 auto; width: 100px; height: 80px; background: blue; position: relative; }
43
&lt;/style&gt;
44
  &lt;script&gt;
45
  $(document).ready(function() {
46
    $(&quot;p&quot;).<a href="http://docs.jquery.com/Events/click" title="Events/click">click</a>(function () {
47
      $(&quot;div&quot;).<strong class="selflink">effect</strong>(&quot;explode&quot;);
48
    });
49
  });
50
  &lt;/script&gt;
51
&lt;/head&gt;
52
&lt;body style="font-size:62.5%;"&gt;
53
  
54
&lt;p&gt;Click me&lt;/p&gt;&lt;div&gt;&lt;/div&gt;
55

    
56
&lt;/body&gt;
57
&lt;/html&gt;
58
</pre>
59
<p></div>
60
</p><p></div>
61
    </div>
62
  </div>
63
  <div id="options">
64
    <h2 class="top-header">Arguments</h2>
65
    <ul class="options-list">
66
      
67
<li class="option" id="option-effect">
68
  <div class="option-header">
69
    <h3 class="option-name"><a href="#option-effect">effect</a></h3>
70
    <dl>
71
      <dt class="option-type-label">Type:</dt>
72
        <dd class="option-type">String</dd>
73
      
74
    </dl>
75
  </div>
76
  <div class="option-description">
77
    <p>The effect to be used. Possible values: 'blind', 'bounce', 'clip', 'drop', 'explode', 'fold', 'highlight', 'puff', 'pulsate', 'scale', 'shake', 'size', 'slide', 'transfer'.</p>
78
  </div>
79
</li>
80

    
81

    
82
<li class="option" id="option-options">
83
  <div class="option-header">
84
    <h3 class="option-name"><a href="#option-options">options</a></h3>
85
    <dl>
86
      <dt class="option-type-label">Type:</dt>
87
        <dd class="option-type">Hash</dd>
88
      
89
      <dt class="option-optional-label">Optional</dt>
90
      
91
    </dl>
92
  </div>
93
  <div class="option-description">
94
    <p>A object/hash including specific options for the effect.</p>
95
  </div>
96
</li>
97

    
98

    
99
<li class="option" id="option-speed">
100
  <div class="option-header">
101
    <h3 class="option-name"><a href="#option-speed">speed</a></h3>
102
    <dl>
103
      <dt class="option-type-label">Type:</dt>
104
        <dd class="option-type">String, Number</dd>
105
      
106
      <dt class="option-optional-label">Optional</dt>
107
      
108
    </dl>
109
  </div>
110
  <div class="option-description">
111
    <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>
112
  </div>
113
</li>
114

    
115

    
116
<li class="option" id="option-callback">
117
  <div class="option-header">
118
    <h3 class="option-name"><a href="#option-callback">callback</a></h3>
119
    <dl>
120
      <dt class="option-type-label">Type:</dt>
121
        <dd class="option-type">Function</dd>
122
      
123
      <dt class="option-optional-label">Optional</dt>
124
      
125
    </dl>
126
  </div>
127
  <div class="option-description">
128
    <p>A function that is called after the effect is completed.</p>
129
  </div>
130
</li>
131

    
132
    </ul>
133
  </div>
134
</div>
135

    
136
</p><!-- 
137
Pre-expand include size: 6364 bytes
138
Post-expand include size: 8780 bytes
139
Template argument size: 5498 bytes
140
Maximum: 2097152 bytes
141
-->
142

    
143
<!-- Saved in parser cache with key jqdocs_docs:pcache:idhash:2612-1!1!0!!en!2 and timestamp 20101025031733 -->
(10-10/23)