Fetching contributors…
Cannot retrieve contributors at this time
302 lines (217 sloc) 14.8 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
<title>JavaScript Snow: DHTML Snowstorm</title>
<meta name="robots" content="noindex" />
<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. Includes wind, velocity, &quot;sticky&quot; 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=""></script>
<script src="lights/christmaslights.js"></script>
<div id="lights">
<!-- lights go here -->
<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.41.20101113</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 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>
<pre>&lt;script src="snowstorm.js"&gt;&lt;/script&gt;</pre>
<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>
<li><a href="">Snowstorm v1.41.20101113</a></li>
<p>Also on Github: <a href=""></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 most of the old major browsers (IE 5.x+, Netscape 6+) as well as IE 6, 7, 8, Firefox, Safari and Opera, and the iPhone. 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 will 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>By default, mobile phones are excluded from the snow effect to be nice to their CPUs (and batteries), but you can set <code>snowStorm.excludeMobile = false;</code> to enable Snowstorm on devices like the iPhone, iPad and Android cell 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>
&lt;script src="snowstorm.js"&gt;&lt;/script&gt;
<p>Once you have snowstorm configured, you can use the optimized, minified version of the code (~40% smaller):</p>
<pre>&lt;script src="snowstorm-min.js"&gt;&lt;/script&gt;</pre>
<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>
<span>&lt;!-- required snowstorm JS, default behaviour --&gt;</span>
&lt;script src="snowstorm.js"&gt;&lt;/script&gt;
<span>&lt;!-- now, we'll customize the snowStorm object --&gt;</span>
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>
<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>
<dt><code>snowStorm.animationInterval = 33;</code></dt>
<dd>Theoretical "miliseconds 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 = '&bull;';</code></dt>
<dd>&amp;bull; (&bull;) = bullet. &amp;middot; entity (&middot;) 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>Element which snow will be appended to (default: document body) - can be an element ID string eg. 'myDiv', or a DOM node reference.</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>
<h2 id="methods">Methods</h2>
<p>Snowstorm has a few basic methods for controlling the snow effect.</p>
<dd>Sets the wind speed with a random value relative to vMaxX and vMaxY properties.</dd>
<dd>Stops the snow effect in place.</dd>
<dd>Continues snowing from a "frozen" state.</dd>
<dd>Enables or disables the snow effect depending on state, same as calling freeze() or resume().</dd>
<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>
<h2 id="versionhistory">Version History</h2>
<h3 id="oldversions">Older versions</h3>
<li><a href="">Snowstorm v1.4.20091115</a></li>
<li><a href="">Snowstorm v1.3.20081215</a></li>
<li><a href="">Snowstorm v1.3.20081208</a></li>
<li><a href="">Snowstorm v1.2.20041121a</a></li>
<li><a href="">Snowstorm v1.2.20031218a</a></li>
<li><a href="">Snowstorm v1.2.20031213a</a></li>
<li><a href="">Snowstorm v1.1.20031206c</a></li>
<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>
<li>Text-based snow (and color options) using "bullet" HTML entity &bull; .. 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>
<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>
<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="" title="JavaScript Sound api, play mp3s with JavaScript">SoundManager 2</a> and <a href="" title="Yahoo! User Interface Library">YUI</a> DOM/Event libraries</li>
<li>Cleaner, simplified event code, removal of old PNG wrapper stuff.</li>
<li>Script moved into one file (snowstorm.js) for simplicity</li>
<li>addEventHandler and PNG support functions updated</li>
<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>
<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>
<li>Initial release</li>
<h2 id="feedback">Feedback</h2>
<h3>Comments, suggestions, questions, criticism?</h3>
<p class="first">
A few contact options are available. <a href="" title="Scott Schiller's contact information">Get in touch</a> via email or IM.
<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="" title="Scott's personal experimental DHTML site"></a>.
<!-- stats/counter stuff for my web site. You don't need this for the snow effect to work. -->
<script>if (navigator.userAgent.match(/msie 6/i)) $('special').style.display = 'inline';</script>
<script type="text/javascript" src=""></script>
<script type="text/javascript">
try {
} catch(err) {}