Attach a Color effect

The Color effect creates the transition of the target element background from one color to another. The Highlight effect uses this effect to highlight an element.

You can attach the Color effect to any HTML element except applet, body, frame, frameset, or noframes.

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.

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 id="color1"><p>Lorem ipsum dolor sit amet, consetetur 
sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut 
labore et dolore magna aliqt</p></div>

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 change color, you might add the following event and script tag:

<p><a onclick="color_effect.start(); return false;" href="#">Click here to change the background color of the paragraph.</a></p>
. . .
<script type="text/javascript">
var color_effect = new Spry.Effect.Color("color1", "#FFCC33", "#CC5512", {duration: 2000});
</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.Color method is always the target element’s ID ("color1" in the preceding example).

The second and third arguments are also required: the second is the starting color of the background in RGB format, and the third is the ending color of the background in RGB format

The complete code looks as follows:

<head>
. . .
<script src="../includes/SpryEffects.js" type="text/javascript"></script>
</head>
<body>
<p><a onclick="color_effect.start(); return false;" href="#">Click here to change the background color of the paragraph.</a></p>
<div id="color1"><p>Lorem ipsum dolor sit amet, consetetur 
sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut 
labore et dolore magna aliqt</p></div>
<script type="text/javascript">
var color_effect = new Spry.Effect.Color("color1", "#FFCC33", "#CC5512", {duration: 2000});
</script>
</body>

Color effect options

The following table lists available options for the Color effect.

Option	Description
duration	Duration of the effect in milliseconds. The default value is 1000.
toggle	Lets you create a toggle effect. The default value is `false`.
transition	Determines the type of transition. The default is `Spry.sinusoidalTransition`.
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.Color("targetID", "#FFCC33", "#CC5512", {duration: 2000, transition: Spry.fifthTransition, toggle: true});

effect.start();