Spry

Attach a Fade effect

The Fade effect makes an element appear or fade away.

You can attach the Fade effect to any HTML element except applet, body, iframe, object, tr, tbody, or th.

  1. To link the SpryEffects.js file on your web page, add the following code to the head of your document: 
    <head>
. . .
<script  src="../includes/SpryEffects.js" type="text/javascript" ></script>
</head>
    Note: The exact file path differs, depending on where you store the SpryEffects.js file.

    The SpryEffects.js file is in the includes folder of the Spry folder that you downloaded from Adobe Labs. See Prepare your files.

  2. Make sure your target element has a unique ID. The target element is the element that changes when the user interacts with the page to cause the effect. 
    <div class="demoDiv" id="fade1">Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna sea takimata sanctus est Lorem ipsum dolor sit amet.</div>
  3. To create the effect, add a JavaScript event to trigger the effect, and a script tag that creates the effect object. For example, if you want the user to click on a sentence that causes another paragraph to fade, you might add the following event and script tag: 
    <p><a onclick="fadeElement.start(); return false;" href="#">Click here to make the paragraph fade from 100% to 20%.</a></p>
. . .
<script type="text/javascript">
var fadeElement = new Spry.Effect.Fade("fade1", {duration:1000, from:100, to:20, toggle:true});
</script>
    Note: It’s important that you add the script tag after the code for the target element. Otherwise the page will return a JavaScript error when you try to trigger the effect.

    The first argument of the Spry.Effect.Fade method is always the target element’s ID ('fade1' in the preceding example).

    The complete code looks as follows:

    <head>
. . . 
<script src="../includes/SpryEffects.js" type="text/javascript"></script>
</head>
<body>
<p><a onclick="fadeElement.start(); return false;" href="#">Click here to make the paragraph fade out from 100% to 20%.</a></p>
<div id="fade1">Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor.</div>
<script type="text/javascript">
var fadeElement = new Spry.Effect.Fade("fade1", {duration:1000, from:100, to:20, toggle:true});
</script>
</body>

Fade effect options

The following table lists available options for the Fade effect.

Option

Description

duration

Duration of the effect in milliseconds. The default value is 1000.

from

Start opacity value in %. The default value is 0.

to

End opacity value in %. The default value is 100.

toggle

Lets you create a toggle effect. The default value is false.

transition

Determines the type of transition. The default is Spry.fifthTransition.

fps

Determines the number of frames per second (fps) of the animation. The default is 60.

setup

Lets you define a function that is called before the effect begins, e.g., setup:function (element,effect){/* ... */}.

finish

Lets you define a function that is called after the effect finishes, e.g., finish:function (element,effect){/* ... */}.

Sample code:

var effect = new Spry.Effect.Fade('targetID', {duration: 2000, from: 0, to: 100, toggle: true});

effect.start();