|
525
|
1 |
<!DOCTYPE html> |
|
|
2 |
<html lang="en"> |
|
|
3 |
<head> |
|
|
4 |
<meta charset="utf-8"> |
|
|
5 |
<title>Transition</title> |
|
|
6 |
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic"> |
|
|
7 |
<link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css"> |
|
|
8 |
<link rel="stylesheet" href="../assets/css/main.css"> |
|
|
9 |
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> |
|
|
10 |
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> |
|
|
11 |
<script src="../../build/yui/yui-min.js"></script> |
|
|
12 |
|
|
|
13 |
</head> |
|
|
14 |
<body> |
|
|
15 |
<!-- |
|
|
16 |
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> |
|
|
17 |
--> |
|
|
18 |
<div id="doc"> |
|
|
19 |
<div id="hd"> |
|
|
20 |
<h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1> |
|
|
21 |
</div> |
|
|
22 |
|
|
|
23 |
<a href="#toc" class="jump">Jump to Table of Contents</a> |
|
|
24 |
|
|
|
25 |
|
|
|
26 |
<h1>Transition</h1> |
|
|
27 |
<div class="yui3-g"> |
|
|
28 |
<div class="yui3-u-3-4"> |
|
|
29 |
<div id="main"> |
|
|
30 |
<div class="content"> <div class="intro"> |
|
|
31 |
<p>The Transition Utility provides an API for creating advanced transitions between style property values. Native CSS Transitions are used when possible.</p> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<h2 id="getting-started">Getting Started</h2> |
|
|
35 |
|
|
|
36 |
<p> |
|
|
37 |
To include the source files for Transition and its dependencies, first load |
|
|
38 |
the YUI seed file if you haven't already loaded it. |
|
|
39 |
</p> |
|
|
40 |
|
|
|
41 |
<pre class="code prettyprint"><script src="http://yui.yahooapis.com/3.10.3/build/yui/yui-min.js"></script></pre> |
|
|
42 |
|
|
|
43 |
|
|
|
44 |
<p> |
|
|
45 |
Next, create a new YUI instance for your application and populate it with the |
|
|
46 |
modules you need by specifying them as arguments to the <code>YUI().use()</code> method. |
|
|
47 |
YUI will automatically load any dependencies required by the modules you |
|
|
48 |
specify. |
|
|
49 |
</p> |
|
|
50 |
|
|
|
51 |
<pre class="code prettyprint"><script> |
|
|
52 |
// Create a new YUI instance and populate it with the required modules. |
|
|
53 |
YUI().use('transition', function (Y) { |
|
|
54 |
// Transition is available and ready for use. Add implementation |
|
|
55 |
// code here. |
|
|
56 |
}); |
|
|
57 |
</script></pre> |
|
|
58 |
|
|
|
59 |
|
|
|
60 |
<p> |
|
|
61 |
For more information on creating YUI instances and on the |
|
|
62 |
<a href="http://yuilibrary.com/yui/docs/api/classes/YUI.html#method_use"><code>use()</code> method</a>, see the |
|
|
63 |
documentation for the <a href="../yui/index.html">YUI Global Object</a>. |
|
|
64 |
</p> |
|
|
65 |
|
|
|
66 |
|
|
|
67 |
<h2 id="using">Using Transitions</h2> |
|
|
68 |
<h3 id="attributes">Transition Method</h3> |
|
|
69 |
<p>The Transition Utility adds the <code>transition</code> method to <code>Node</code> instances when the <code>transition</code> module is included. The method accepts a configuration object, and an optional callback function. The config may include one or more <code>CSS</code> properties to be transitioned, an optional <code>duration</code> (in seconds), <code>delay</code>, and <code>easing</code> for fine-tuning transition behavior. Calling the <code>transition</code> method begins the transition. The <code>callback</code> is run after the transition has completed.</p> |
|
|
70 |
|
|
|
71 |
<pre class="code prettyprint">Y.one('#demo').transition({ |
|
|
72 |
easing: 'ease-out', |
|
|
73 |
duration: 0.75, // seconds |
|
|
74 |
width: '10px', |
|
|
75 |
height: '10px' |
|
|
76 |
}, function() { |
|
|
77 |
this.remove(); |
|
|
78 |
});</pre> |
|
|
79 |
|
|
|
80 |
|
|
|
81 |
<h3 id="easings">Supported Easings</h3> |
|
|
82 |
|
|
|
83 |
<p>Transition supports the following easings:</p> |
|
|
84 |
<table> |
|
|
85 |
<thead> |
|
|
86 |
<tr> |
|
|
87 |
<th>Easing</th> |
|
|
88 |
<th>Description</th> |
|
|
89 |
</tr> |
|
|
90 |
</thead> |
|
|
91 |
<tbody> |
|
|
92 |
<tr> |
|
|
93 |
<td><code>cubic-bezier</code></td> |
|
|
94 |
<td>Specifies a cubic-bezier curve. The four values specify points P1 and P2 of the curve as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid.</td> |
|
|
95 |
</tr> |
|
|
96 |
<tr> |
|
|
97 |
<td><code>ease (default)</code></td> |
|
|
98 |
<td>equivalent to cubic-bezier(0.25, 0.1, 0.25, 1)</td> |
|
|
99 |
</tr> |
|
|
100 |
<tr> |
|
|
101 |
<td><code>linear</code></td> |
|
|
102 |
<td>equivalent to cubic-bezier(0, 0, 1, 1)</td> |
|
|
103 |
</tr> |
|
|
104 |
<tr> |
|
|
105 |
<td><code>ease-in</code></td> |
|
|
106 |
<td>equivalent to cubic-bezier(0.42, 0, 1, 1)</td> |
|
|
107 |
</tr> |
|
|
108 |
<tr> |
|
|
109 |
<td><code>ease-out</code></td> |
|
|
110 |
<td>equivalent to cubic-bezier(0, 0, 0.58, 1)</td> |
|
|
111 |
</tr> |
|
|
112 |
<tr> |
|
|
113 |
<td><code>ease-in-out</code></td> |
|
|
114 |
<td>equivalent to cubic-bezier(0.42, 0, 0.58, 1)</td> |
|
|
115 |
</tr> |
|
|
116 |
</tbody> |
|
|
117 |
</table> |
|
|
118 |
<p>Transition easings are defined as part of the CSS3 Transition Module. See the <a href="http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag">full specification</a> for further details. |
|
|
119 |
|
|
|
120 |
<h3 id="attr-specific">Property Specific Attributes</h3> |
|
|
121 |
|
|
|
122 |
<p>The Transition Utility also allows for property specific attributes. Each attribute may optionally have its own <code>duration</code>, </code>easing</code>, and/or <code>delay</code>. This provides much finer control over the transition timeline, enabling more complex effects.</p> |
|
|
123 |
|
|
|
124 |
<pre class="code prettyprint">Y.one('#demo').transition({ |
|
|
125 |
duration: 0.75, |
|
|
126 |
easing: 'ease-out', |
|
|
127 |
|
|
|
128 |
height: 0, |
|
|
129 |
|
|
|
130 |
width: { |
|
|
131 |
delay: 0.75, |
|
|
132 |
easing: 'ease-in', |
|
|
133 |
value: 0 |
|
|
134 |
}, |
|
|
135 |
|
|
|
136 |
opacity: { |
|
|
137 |
delay: 1.5, |
|
|
138 |
duration: 1.25, |
|
|
139 |
value: 0 |
|
|
140 |
} |
|
|
141 |
});</pre> |
|
|
142 |
|
|
|
143 |
|
|
|
144 |
|
|
|
145 |
<h3 id="transition-events">Listening for Events</h3> |
|
|
146 |
<p>The Transition Utility provides optional notifications for reacting to the start and end of a transition. These can be subscribed to via the <code>on</code> attribute of the transition config.</p> |
|
|
147 |
|
|
|
148 |
<pre class="code prettyprint">var node = Y.one('#demo'); |
|
|
149 |
|
|
|
150 |
Y.one('#demo').transition({ |
|
|
151 |
duration: 1, |
|
|
152 |
height:0, |
|
|
153 |
|
|
|
154 |
width: { |
|
|
155 |
delay: 1, |
|
|
156 |
duration: 0.5, |
|
|
157 |
value: 0 |
|
|
158 |
}, |
|
|
159 |
|
|
|
160 |
on: { |
|
|
161 |
start: function() { |
|
|
162 |
Y.log('start'); |
|
|
163 |
}, |
|
|
164 |
|
|
|
165 |
end: function() { |
|
|
166 |
Y.log('end'); |
|
|
167 |
} |
|
|
168 |
} |
|
|
169 |
});</pre> |
|
|
170 |
|
|
|
171 |
|
|
|
172 |
<p>For simplicity, an end handler can also be added as a function callback: |
|
|
173 |
|
|
|
174 |
<pre class="code prettyprint">Y.one('#demo').transition({ |
|
|
175 |
duration: 1, |
|
|
176 |
height:0, |
|
|
177 |
|
|
|
178 |
width: { |
|
|
179 |
delay: 1, |
|
|
180 |
duration: 0.5, |
|
|
181 |
value: 0 |
|
|
182 |
} |
|
|
183 |
}, function() { |
|
|
184 |
Y.log('end'); |
|
|
185 |
});</pre> |
|
|
186 |
|
|
|
187 |
</div> |
|
|
188 |
</div> |
|
|
189 |
</div> |
|
|
190 |
|
|
|
191 |
<div class="yui3-u-1-4"> |
|
|
192 |
<div class="sidebar"> |
|
|
193 |
|
|
|
194 |
<div id="toc" class="sidebox"> |
|
|
195 |
<div class="hd"> |
|
|
196 |
<h2 class="no-toc">Table of Contents</h2> |
|
|
197 |
</div> |
|
|
198 |
|
|
|
199 |
<div class="bd"> |
|
|
200 |
<ul class="toc"> |
|
|
201 |
<li> |
|
|
202 |
<a href="#getting-started">Getting Started</a> |
|
|
203 |
</li> |
|
|
204 |
<li> |
|
|
205 |
<a href="#using">Using Transitions</a> |
|
|
206 |
<ul class="toc"> |
|
|
207 |
<li> |
|
|
208 |
<a href="#attributes">Transition Method</a> |
|
|
209 |
</li> |
|
|
210 |
<li> |
|
|
211 |
<a href="#easings">Supported Easings</a> |
|
|
212 |
</li> |
|
|
213 |
<li> |
|
|
214 |
<a href="#attr-specific">Property Specific Attributes</a> |
|
|
215 |
</li> |
|
|
216 |
<li> |
|
|
217 |
<a href="#transition-events">Listening for Events</a> |
|
|
218 |
</li> |
|
|
219 |
</ul> |
|
|
220 |
</li> |
|
|
221 |
</ul> |
|
|
222 |
</div> |
|
|
223 |
</div> |
|
|
224 |
|
|
|
225 |
|
|
|
226 |
|
|
|
227 |
<div class="sidebox"> |
|
|
228 |
<div class="hd"> |
|
|
229 |
<h2 class="no-toc">Examples</h2> |
|
|
230 |
</div> |
|
|
231 |
|
|
|
232 |
<div class="bd"> |
|
|
233 |
<ul class="examples"> |
|
|
234 |
|
|
|
235 |
|
|
|
236 |
<li data-description="Demonstrates the basic usage of Transitions."> |
|
|
237 |
<a href="transition-basic.html">Basic Node Transitions</a> |
|
|
238 |
</li> |
|
|
239 |
|
|
|
240 |
|
|
|
241 |
|
|
|
242 |
<li data-description="Demonstrates more advanced usage of Transitions."> |
|
|
243 |
<a href="transition-usage.html">Using Transitions</a> |
|
|
244 |
</li> |
|
|
245 |
|
|
|
246 |
|
|
|
247 |
|
|
|
248 |
<li data-description="Demonstrates how to animate Node's show and hide methods."> |
|
|
249 |
<a href="transition-view.html">Showing and Hiding with Transitions</a> |
|
|
250 |
</li> |
|
|
251 |
|
|
|
252 |
|
|
|
253 |
|
|
|
254 |
|
|
|
255 |
|
|
|
256 |
|
|
|
257 |
|
|
|
258 |
|
|
|
259 |
|
|
|
260 |
|
|
|
261 |
|
|
|
262 |
|
|
|
263 |
|
|
|
264 |
|
|
|
265 |
|
|
|
266 |
|
|
|
267 |
</ul> |
|
|
268 |
</div> |
|
|
269 |
</div> |
|
|
270 |
|
|
|
271 |
|
|
|
272 |
|
|
|
273 |
<div class="sidebox"> |
|
|
274 |
<div class="hd"> |
|
|
275 |
<h2 class="no-toc">Examples That Use This Component</h2> |
|
|
276 |
</div> |
|
|
277 |
|
|
|
278 |
<div class="bd"> |
|
|
279 |
<ul class="examples"> |
|
|
280 |
|
|
|
281 |
|
|
|
282 |
|
|
|
283 |
|
|
|
284 |
|
|
|
285 |
|
|
|
286 |
|
|
|
287 |
|
|
|
288 |
<li data-description="Shows how to create a panel that animates as it is shown and hidden"> |
|
|
289 |
<a href="../panel/panel-animate.html">Creating an Animated Panel</a> |
|
|
290 |
</li> |
|
|
291 |
|
|
|
292 |
|
|
|
293 |
|
|
|
294 |
<li data-description="This example employs AsyncQueue to incrementally construct an application interface; this illustrates the approach you'd take to allow chunked rendering of the UI in a process-intensive application."> |
|
|
295 |
<a href="../async-queue/queue-app.html">Building a UI with AsyncQueue</a> |
|
|
296 |
</li> |
|
|
297 |
|
|
|
298 |
|
|
|
299 |
|
|
|
300 |
<li data-description="Extend the Promise class to create your own Node plugin that chains transitions"> |
|
|
301 |
<a href="../promise/plugin-example.html">Creating a Node Plugin that chains transitions</a> |
|
|
302 |
</li> |
|
|
303 |
|
|
|
304 |
|
|
|
305 |
|
|
|
306 |
<li data-description="Create a reusable JSONPRequest object to poll the YUILibrary.com Gallery web service, fetching info on a random Gallery module."> |
|
|
307 |
<a href="../jsonp/jsonp-gallery.html">Reusing a JSONPRequest Instance to Poll a Remote Server</a> |
|
|
308 |
</li> |
|
|
309 |
|
|
|
310 |
|
|
|
311 |
|
|
|
312 |
<li data-description="NodeList provides Node functionality for manipulating multiple nodes at once."> |
|
|
313 |
<a href="../node/nodelist.html">Using NodeList - Simple</a> |
|
|
314 |
</li> |
|
|
315 |
|
|
|
316 |
|
|
|
317 |
|
|
|
318 |
<li data-description="How to use multiple NodeList features to build a simple game."> |
|
|
319 |
<a href="../node/ducks.html">Using NodeList - Ducks Game</a> |
|
|
320 |
</li> |
|
|
321 |
|
|
|
322 |
|
|
|
323 |
|
|
|
324 |
<li data-description="This example demonstrates how to insert content into a Node."> |
|
|
325 |
<a href="../node/node-insert.html">Adding Node Content - Burger Builder</a> |
|
|
326 |
</li> |
|
|
327 |
|
|
|
328 |
|
|
|
329 |
</ul> |
|
|
330 |
</div> |
|
|
331 |
</div> |
|
|
332 |
|
|
|
333 |
</div> |
|
|
334 |
</div> |
|
|
335 |
</div> |
|
|
336 |
</div> |
|
|
337 |
|
|
|
338 |
<script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
|
339 |
<script>prettyPrint();</script> |
|
|
340 |
|
|
|
341 |
<script> |
|
|
342 |
YUI.Env.Tests = { |
|
|
343 |
examples: [], |
|
|
344 |
project: '../assets', |
|
|
345 |
assets: '../assets/transition', |
|
|
346 |
name: 'transition', |
|
|
347 |
title: 'Transition', |
|
|
348 |
newWindow: '', |
|
|
349 |
auto: false |
|
|
350 |
}; |
|
|
351 |
YUI.Env.Tests.examples.push('transition-basic'); |
|
|
352 |
YUI.Env.Tests.examples.push('transition-usage'); |
|
|
353 |
YUI.Env.Tests.examples.push('transition-view'); |
|
|
354 |
YUI.Env.Tests.examples.push('panel-animate'); |
|
|
355 |
YUI.Env.Tests.examples.push('queue-app'); |
|
|
356 |
YUI.Env.Tests.examples.push('plugin-example'); |
|
|
357 |
YUI.Env.Tests.examples.push('jsonp-gallery'); |
|
|
358 |
YUI.Env.Tests.examples.push('nodelist'); |
|
|
359 |
YUI.Env.Tests.examples.push('ducks'); |
|
|
360 |
YUI.Env.Tests.examples.push('node-insert'); |
|
|
361 |
|
|
|
362 |
</script> |
|
|
363 |
<script src="../assets/yui/test-runner.js"></script> |
|
|
364 |
|
|
|
365 |
|
|
|
366 |
|
|
|
367 |
</body> |
|
|
368 |
</html> |