Skip to content

Commit 6ba1642

Browse files
committed
jQuery.effects.clipToBox: Initial docs
Ref gh-242 Ref gh-288
1 parent 4b85611 commit 6ba1642

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

entries/jQuery.effects.clipToBox.xml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0"?>
2+
<entries>
3+
<entry type="method" name="jQuery.effects.clipToBox" return="Object" added="1.12">
4+
<title>jQuery.effects.clipToBox()</title>
5+
<signature>
6+
<argument name="animationProperties" type="Object">
7+
<desc>A set of properties that will eventually be passed to <a href="//api.jquery.com/animate/"><code>.animate()</code></a>. The <code>animationProperties</code> must contain a <code>clip</code> property.</desc>
8+
</argument>
9+
</signature>
10+
<desc>Calculates position and dimensions based on a clip animation.</desc>
11+
<longdesc>
12+
<p>This method is useful for mimicking a clip animation when using a placeholder for effects. Given a clip animation, <code>jQuery.effects.clipToBox()</code> will generate an object containing <code>top</code>, <code>left</code>, <code>width</code>, and <code>height</code> properties which can be passed to <a href="//api.jquery.com/css/"><code>.css()</code></a> or <a href="//api.jquery.com/animate/"><code>.animate()</code></a>. This method is generally used in conjunction with <a href="/jQuery.effects.createPlaceholder/"><code>jQuery.effects.createPlaceholder()</code></a>.</p>
13+
</longdesc>
14+
<category slug="effects-core"/>
15+
<category slug="effects"/>
16+
</entry>
17+
</entries>

0 commit comments

Comments
 (0)