/
hide.xml
60 lines (60 loc) · 2.04 KB
/
hide.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?xml version="1.0"?>
<entry name="hide" type="method" return="jQuery">
<title>.hide()</title>
<desc>Hide the matched elements, using custom effects.</desc>
<longdesc>
<xi:include href="../includes/core-extension-desc.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</longdesc>
<signature>
<argument name="effect" type="String">
<desc>A string indicating which <a href="/category/effect/">effect</a> to use for the transition.</desc>
</argument>
<argument name="options" type="Object" optional="true">
<desc>Effect-specific settings and easing.</desc>
</argument>
<xi:include href="../includes/animation-argument-duration.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
<xi:include href="../includes/animation-argument-complete.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
</signature>
<signature>
<argument name="options" type="Object">
<desc>All animation settings. The only required property is <code>effect</code>.</desc>
<property name="effect" type="String">
<desc>A string indicating which <a href="/category/effect/">effect</a> to use for the transition.</desc>
</property>
<property name="easing" type="String">
<desc>A string indicating which easing function to use for the transition.</desc>
</property>
<property name="duration">
<desc>A string or number determining how long the animation will run.</desc>
<type name="Number"/>
<type name="String"/>
</property>
<property name="complete" type="Function">
<desc>A function to call once the animation is complete.</desc>
</property>
</argument>
</signature>
<example>
<desc>Hide a div using the drop effect.</desc>
<css><![CDATA[
div {
width: 100px;
height: 100px;
background: #ccc;
border: 1px solid #000;
}
]]></css>
<html><![CDATA[
<button>hide the div</button>
<div></div>
]]></html>
<code><![CDATA[
$( "button" ).click(function() {
$( "div" ).hide( "drop", { direction: "down" }, "slow" );
});
]]></code>
</example>
<category slug="methods"/>
<category slug="effects"/>
<category slug="overrides"/>
</entry>