Spry

Attach a Shake effect

The Shake effect rapidly shakes the target element a distance of 20 pixels from left to right.

You can only attach this effect to the following HTML elements: address, blockquote, dd, div, dl, dt, fieldset, form, h1, h2, h3, h4, h5, h6, iframe, img, object, p, ol, ul, li, applet, dir, hr, menu, pre, or table.

  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 id="shake1">Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliqit 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 shake, you might add the following event and script tag: 
    <p><a onclick="shake_effect.start(); return false;" href="#">Shake it!</a></p>
. . .
<script type="text/javascript">
	var shake_effect = new Spry.Effect.Shake("shake1");
</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.Shake method is always the target element’s ID ("shake1" 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="shake_effect.start(); return false;" href="#">Shake it!</a></p>
<div id="shake1">Lorem ipsum dolor sit amet, consetetur sadipscing elitr.</div>
<script type="text/javascript">
	var shake_effect = new Spry.Effect.Shake("shake1");
</script>
</body>

Shake effect options

The following table lists available options for the Shake effect.

Option

Description

duration

Fixed at 500 milliseconds in Spry 1.4. Only editable in Spry 1.5 and later.

transition

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

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 Spry.Effect.Shake('targetID');

effect.start();