jQuery UI API - .effect()
Category
Effects | Effects Core | Methods
Usage
Description: Apply an animation effect to an element.
Returns: jQuery
| Parameter | Type | Description | Default Value |
|---|---|---|---|
| effect | String | A string indicating which effect to use | |
| options | Object | Specific settings for the effect and easing | |
| duration | Number or String | A string or number specifying how long the animation will run | 400 |
| complete | Function() | A function to call once the animation is complete |
| Parameter | Type | Description |
|---|---|---|
| options | Object | All animation settings. The only required property is effect. effect<br>Type: String<br>Description: A string indicating which effect to use.<br><br>easing (Default: "swing")<br>Type: String<br>Description: A string indicating the easing function to use.<br><br>duration (Default: 400)<br>Type: Number or String<br>Description: A string or number specifying how long the animation will run.<br><br>complete<br>Type: Function()<br>Description: A function to call once the animation is complete.<br><br>queue (Default: true)<br>Type: Boolean or String<br>Description: A boolean indicating whether to place the animation in the effects queue. If false, the animation will begin immediately. As of jQuery 1.7, the queue option also accepts a string, in which case the animation is added to the queue represented by that string. |
The .effect() method applies a named animation effect to an element. Many effects also support show or hide modes, which can be accomplished via the .show(), .hide(), and .toggle() methods.
Example
Apply a bounce effect to a div.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>.effect() Demo</title>
<link rel="stylesheet" href="//code.jquery.com/ui/1.10.4/themes/smoothness/jquery-ui.css">
<style>
div {
width: 100px;
height: 100px;
background: #ccc;
border: 1px solid #000;
}
</style>
<script src="//code.jquery.com/jquery-1.10.2.js"></script>
<script src="//code.jquery.com/ui/1.10.4/jquery-ui.js"></script>
</head>
<body>
<p>Click anywhere to apply the effect.</p>
<div></div>
<script>
$(document).click(function() {
$("div").effect("bounce", "slow");
});
</script>
</body>
</html>