forked from scottschiller/Snowstorm
/
index.html
350 lines (257 loc) · 17.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>JavaScript Snow: DHTML Snowstorm. Making it snow on the internets since 2003.</title>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
<meta name="description" content="Realistic JavaScript snow effect for your web site. Free for any use. BSD license. Includes wind, velocity, "sticky" snow and fading effects. Single file, easy to set up and customize." />
<meta name="keywords" content="DHTML Snowstorm, DHTML snow, javascript snow, snow effect, Scott Schiller, Schill, Schillmania" />
<meta name="author" content="Scott Schiller" />
<meta name="copyright" content="Copyright (C) 2003 Scott Schiller" />
<meta name="language" content="en-us" />
<link type="text/css" rel="stylesheet" href="demo/demo_default.css" />
<!-- Copy the <script> tag into your own page(s) for the snow effect. That is all! (No CSS etc. is needed) -->
<script src="snowstorm.js"></script>
<!-- for the Snowstorm homepage, allow the demo to run on iPhone and mobile devices. -->
<script>snowStorm.excludeMobile = false;</script>
<!-- bonus christmas light stuff, not required for snowstorm -->
<script src="lights/soundmanager2-nodebug-jsmin.js"></script>
<script src="http://yui.yahooapis.com/combo?2.6.0/build/yahoo-dom-event/yahoo-dom-event.js&2.6.0/build/animation/animation-min.js"></script>
<script src="lights/christmaslights.js"></script>
</head>
<body>
<div id="lights">
<!-- lights go here -->
</div>
<div id="container">
<div id="content">
<h1>Snowstorm: A JavaScript Snow Effect for HTML</h1>
<p class="alt noTop">Bringing snow to the web since 2003. This version: 1.44.20131208</p>
<p>
<a href="#" onclick="snowStorm.randomizeWind();return false">Change Wind</a> | <a href="#" onclick="snowStorm.stop();return false">Stop Snowing</a> | Bonus widget: <a href="lights/" onclick="if (document.location.protocol != 'http') this.href=this.href+'index.html'">Smash Christmas Lights</a>
</p>
<p id="special" class="special">(Note: Christmas Lights are incompatible with IE 6 because of PNG images.)</p>
<h2>Let It Snow.</h2>
<h3>So, you want JavaScript snow on your web site, eh?</h3>
<p class="first">Snowstorm is a JavaScript-driven snow effect that can be easily added to web pages. It is free for use, and easy to set up. A single JavaScript file provides the functionality required. No images are used for the snow effect.</p>
<h3>I'd like to use this on my site.</h3>
<p>This is all you need to get started:</p>
<p>
<pre><script src="snowstorm.js"></script></pre>
</p>
<p>See this <a href="basic-example.html" title="Simple Snowstorm demo">basic example</a> for reference.</p>
<h3>What kind of things can I customize?</h3>
<p>You can adjust the snow speed, the amount of snow, the "wind", if and where it should stick (and if it should "melt"), and finally, whether the snow can react to the mouse moving (ie., "wind changes.") See <a href="#customizing" title="Customizing snow storm behaviour">Customizing Snowstorm</a> for more.</p>
<h3>And the Christmas Lights?</h3>
<p>The christmas lights are a separate experimental script which also has an <a href="lights/" onclick="if (document.location.protocol != 'http') this.href=this.href+'index.html'">example</a>. It is undocumented, but the script can be modified to taste if you're the adventurous type.</p>
<h2 id="download">Download</h2>
<p class="first">ZIP file, includes this demo page and source code.</p>
<ul>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv144_20131208.zip">Snowstorm v1.44.20131208</a></li>
</ul>
<p>Also on Github: <a href="http://github.com/scottschiller/snowstorm/">github.com/scottschiller/snowstorm/</a></p>
<h2 id="license">License</h2>
<p class="first">Snowstorm is provided under a <a href="license.txt" title="Snowstorm BSD license">BSD license</a>.</p>
<h2 id="technotes">Technical Notes</h2>
<p class="first">Snowstorm works under modern browsers, and as far back as IE 6 - possibly even 5.5, if you can find a copy!</p>
<p>If you are seeing snow as you read this, then the script is working as expected.</p>
<h3>CPU Use</h3>
<p class="first">Snowstorm can eat up a lot of CPU, even on modern computers, because of the number of elements being moved around the screen at once. The <a href="basic-example.html" title="Simple Snowstorm demo">basic example</a> may have notably lower CPU use as it doesn't include the christmas lights, and the page layout is much simpler. Consider raising the animation interval, and lowering the amount of snowflakes (active and max) to help reduce CPU use.</p>
<p>Where supported, Snowstorm will attempt to use GPU-based hardware acceleration to draw and animate the snow. Having GPU acceleration can help in reducing CPU load.</p>
<h3>Mobile Support</h3>
<p>By default, mobile devices are excluded from the snow effect to be nice to their CPUs (and batteries.) If your local marketing department insists, <i>"This must work on mobile!"</i> despite being warned of the downsides, you can set <code style="white-space:nowrap">snowStorm.excludeMobile = false;</code> (or edit the snowstorm.js file directly) to enable Snowstorm on devices like the iPhone, iPad and Android phones etc. This demo page has the effect enabled for mobile devices.</p>
<h2 id="howto">Implementation</h2>
<p class="first">One JavaScript reference is required. Aside from customization, that's it!</p>
<pre>
<script src="snowstorm.js"></script>
</pre>
<p>Once you have snowstorm configured, you can use the optimized, minified version of the code (~40% smaller):</p>
<p>
<pre><script src="snowstorm-min.js"></script></pre>
</p>
<h2 id="customizing">Customizing Snowstorm</h2>
<p>Once you have Snowstorm running in your page, you can customize its properties either by editing the snowstorm.js file directly, or assigning new values to the snowStorm object after snowstorm.js has loaded.</p>
<p>For example:</p>
<pre>
<span><!-- required snowstorm JS, default behaviour --></span>
<script src="snowstorm.js"></script>
<span><!-- now, we'll customize the snowStorm object --></span>
<script>
snowStorm.snowColor = '#99ccff'; <span> // blue-ish snow!?</span>
snowStorm.flakesMaxActive = 96; <span> // show more snow on screen at once</span>
snowStorm.useTwinkleEffect = true; <span>// let the snow flicker in and out of view</span>
</script>
</pre>
<p>See this <a href="basic-example-customized.html" title="Snowstorm with custom options">customized example</a> in action.</p>
<h2 id="properties">Configurable Properties</h2>
<p class="first">Snowstorm can be fairly easily customized; some of the major properties are listed below.</p>
<dl>
<dt><code>snowStorm.autoStart = true;</code></dt>
<dd>Whether the snow should start automatically or not.</dd>
<dt><code>snowStorm.animationInterval = 33;</code></dt>
<dd>Theoretical "milliseconds per frame" measurement. 20 = fast + smooth, but high CPU use. 50 = more conservative, but slower</dd>
<dt><code>snowStorm.flakeBottom = null;</code></dt>
<dd>Limits the "floor" (pixels) of the snow. If unspecified, snow will "stick" to the bottom of the browser window and persists through browser resize/scrolling.</dd>
<dt><code>snowStorm.flakesMax = 128;</code></dt>
<dd>Sets the maximum number of snowflakes that can exist on the screen at any given time.</dd>
<dt><code>snowStorm.flakesMaxActive = 64;</code></dt>
<dd>Sets the limit of "falling" snowflakes (ie. moving on the screen, thus considered to be active.)</dd>
<dt><code>snowStorm.followMouse = true;</code></dt>
<dd>Allows snow to move dynamically with the "wind", relative to the mouse's X (left/right) coordinates.</dd>
<dt><code>snowStorm.freezeOnBlur = true;</code></dt>
<dd>Stops the snow effect when the browser window goes out of focus, eg., user is in another tab. Saves CPU, nicer to user.</dd>
<dt><code>snowStorm.snowColor = '#fff';</code></dt>
<dd>Don't eat (or use?) yellow snow.</dd>
<dt><code>snowStorm.snowCharacter = '•';</code></dt>
<dd>&bull; (•) = bullet. &middot; entity (·) is not used as it's square on some systems etc. Changing this may result in cropping of the character and may require flakeWidth/flakeHeight changes, so be careful.</dd>
<dt><code>snowStorm.snowStick = true;</code></dt>
<dd>Allows the snow to "stick" to the bottom of the window. When off, snow will never sit at the bottom.</dd>
<dt><code>snowStorm.targetElement = null;</code></dt>
<dd>An HTML element which snow will be appended to (default: document body.) Can be an element ID string eg. 'myDiv', or a DOM node reference. See <a href="target-element-relative-example.html">relative</a> and <a href="target-element-absolute-example.html">absolute</a>-positioned examples.</dd>
<dt><code>snowStorm.useMeltEffect = true;</code></dt>
<dd>When recycling fallen snow (or rarely, when falling), have it "melt" and fade out if browser supports it</dd>
<dt><code>snowStorm.useTwinkleEffect = true;</code></dt>
<dd>Allow snow to randomly "flicker" in and out of view while falling</dd>
<dt><code>snowStorm.usePositionFixed = false;</code></dt>
<dd>true = snow not affected by window scroll. may increase CPU load, disabled by default - if enabled, used only where supported.</dd>
<dt><code>snowStorm.vMaxX = 8;<br />snowStorm.vMaxY = 5;</code></dt>
<dd>Defines maximum X and Y velocities for the storm; a random value in this range is selected for each snowflake.</dd>
</dl>
<h2 id="methods">Methods</h2>
<p>Snowstorm has a few basic methods for controlling the snow effect.</p>
<dl>
<dt><code>snowStorm.randomizeWind()</code></dt>
<dd>Sets the wind speed with a random value relative to vMaxX and vMaxY properties.</dd>
<dt><code>snowStorm.freeze()</code></dt>
<dd>Stops the snow effect in place.</dd>
<dt><code>snowStorm.resume()</code></dt>
<dd>Continues snowing from a "frozen" state.</dd>
<dt><code>snowStorm.toggleSnow()</code></dt>
<dd>Enables or disables the snow effect depending on state, same as calling freeze() or resume().</dd>
<dt><code>snowStorm.stop()</code></dt>
<dd>Freezes and kills the snowstorm effect, and removes related event handlers. Snowstorm will not work properly if other methods are called after stop().</dd>
</dl>
<h2 id="versionhistory">Version History</h2>
<h3 id="oldversions">Older versions</h3>
<ul>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv144_20131125.zip">Snowstorm v1.44.20131125</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv144_20131111.zip">Snowstorm v1.44.20131111</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv143_20111201.zip">Snowstorm v1.43.20111201</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv142_20111120.zip">Snowstorm v1.42.20111120</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv141_20101113.zip">Snowstorm v1.41.20101113</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv14_20091115.zip">Snowstorm v1.4.20091115</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv13_20081215.zip">Snowstorm v1.3.20081215</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstormv13_20081208.zip">Snowstorm v1.3.20081208</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstorm_20041121a.zip">Snowstorm v1.2.20041121a</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstorm_20031218a.zip">Snowstorm v1.2.20031218a</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstorm_20031213a.zip">Snowstorm v1.2.20031213a</a></li>
<li><a href="http://www.schillmania.com/projects/snowstorm/snowstorm_20031206c.zip">Snowstorm v1.1.20031206c</a></li>
</ul>
<h3>1.44.20131208</h3>
<ul>
<li>Added <code>usePixelPosition</code> to allow forcing of pixels for left/top positioning vs. percentage-based values.</li>
<li>Detect and force pixel-based positioning if <code>targetElement</code> is specified, or <code>body</code> is relatively-positioned.</li>
<li>Adjust positioning logic for <code>targetElement</code> case.</li>
</ul>
<h3>1.44.20131125</h3>
<ul>
<li>Fixed regression where <code>flakeBottom</code> would result in snow not properly sticking.</li>
<li>Percent based left/right positioning is now applied in all browsers, making resizing better.</li>
</ul>
<h3>1.44.20131111</h3>
<ul>
<li>GPU (hardware)-accelerated snow, where supported. Faster drawing, less load on CPU.</li>
<li>Percent-based bottom/right positioning of snow, rather than top/left-based pixel-based positioning (where supported.)</li>
<li>JSLint cleanup.</li>
<li>Fixed the color of christmas light fragments to match the lights, finally.</li>
<li>Design/layout tweaks, slightly more modern.</li>
</ul>
<h3>1.43.20111201</h3>
<ul>
<li>ImageOptim-optimized image files (byte savings)</li>
<li>Added snowStorm.autoStart, for those who want to start snow at their own leisure</li>
<li>Additional Mobile check: Opera Mobile</li>
<li>cursor:default over snow (instead of text I-beam cursor)</li>
<li>meltFrame animation counter correction (possible JS error fix)</li>
</ul>
<h3>1.42.20111120</h3>
<ul>
<li>Tweaked right margin for IE 9 under Windows 7, fixing horizontal scrollbar issue</li>
<li>Re-appeased the jslint gods</li>
</ul>
<h3>1.41.20101113</h3>
<ul>
<li>Added formal BSD license (project was previously "free for any use.")</li>
<li>Modernized event add/remove handlers, wait for window.onload() before starting</li>
<li>New excludeMobile option, ignore iPhone etc. by default (high CPU use on mobile is evil for both CPU, and batteries.)</li>
<li>New freezeOnBlur option, allow control of previously-hardcoded behaviour</li>
<li>Focus-based freezeOnBlur now works under IE 6, too</li>
<li>Code cleanup, now passes updated (more-strict) jslint validation</li>
</ul>
<h3>1.4.20091115</h3>
<ul>
<li>Text-based snow (and color options) using "bullet" HTML entity • .. no more images!</li>
<li>New snowMelt effect, resize + fade where supported</li>
<li>New twinkle effect (like stars)</li>
<li>New animationInterval, usePositionFixed, snowColor attributes, common attributes now public on snowStorm object eg. snowStorm.stick = true;</li>
<li>Code passes jslint validation (2009-10-04 edition, default settings)</li>
<li>Removed "collect" feature, somewhat-buggy and nobody used it</li>
<li>Fixed sticky/recycle behaviour</li>
</ul>
<h3>1.3.20081215</h3>
<ul>
<li>IE doctype rendering tweak: position:absolute used for "BackCompat" (HTML 4 transitional) DOCTYPE in IE.</li>
<li>Fixed an annoying horizontal scrollbar positioning-related bug with wind affecting snow near the right edge.</li>
</ul>
<h3>1.3.20081208</h3>
<ul>
<li>New snowStick (snow stickiness) and followMouse (dynamic wind) options.</li>
<li>Four years later, we still have IE 6 and can't use position:fixed globally for "sticky" snow, but we're really close.</li>
<li>Position:fixed used for all more modern browsers.</li>
<li>Improved distribution of initial snow dump, new recycling.</li>
<li>Focus/blur events (minus IE) for graceful pausing of snow, sparing user's CPU when window not in focus.</li>
<li>Bonus smashable christmas lights demo, using <a href="http://schillmania.com/projects/soundmanager2/" title="JavaScript Sound api, play mp3s with JavaScript">SoundManager 2</a> and <a href="http://developer.yahoo.com/yui/" title="Yahoo! User Interface Library">YUI</a> DOM/Event libraries</li>
<li>Cleaner, simplified event code, removal of old PNG wrapper stuff.</li>
</ul>
<h3>1.2.20041121a</h3>
<ul>
<li>Script moved into one file (snowstorm.js) for simplicity</li>
<li>addEventHandler and PNG support functions updated</li>
</ul>
<h3>1.2.20031218a</h3>
<ul>
<li>Opera 7 ("O7") support added.. I think.</li>
<li>Improved initialization speed (less snowflake objects on startup)</li>
<li>Err.. That's about it.</li>
</ul>
<h3>1.2.20031213a</h3>
<ul>
<li>Netscape 6.x "sticky" snow behavior fixed (now works)</li>
<li>IE:mac bug event handler bug fixed (script should now work)</li>
<li>Snow collection feature added</li>
<li>Snowflake speed is relative to size (Cheap pseudo-3D effect)</li>
</ul>
<h3>1.1.20031206c</h3>
<ul>
<li>Initial release</li>
</ul>
<h2 id="feedback">Feedback</h2>
<h3>Comments, suggestions, questions, criticism?</h3>
<p class="first">
A few contact options are available. <a href="http://schillmania.com/content/react/contact/" title="Scott Schiller's contact information">Get in touch</a> via email or IM.
</p>
<h2 id="elsewhere">Elsewhere On The Internets</h2>
<p class="first">
This is a side project by Scott Schiller. Wacky DHTML/JavaScript experiments and other nonsense can be found at <a href="http://www.schillmania.com/" title="Scott's personal experimental DHTML site">schillmania.com</a>.
</p>
</div>
</div>
<!-- stats/counter stuff for my web site. You don't need this for the snow effect to work. -->
<script type="text/javascript" src="http://include.reinvigorate.net/re_.js"></script>
<script type="text/javascript">
try {
reinvigorate.track("vq4zg-s08a9v69iv");
} catch(err) {}
</script>
</body>
</html>