Permalink
Browse files

Added .show(), .hide(), .toggle().

  • Loading branch information...
1 parent 1c050d6 commit c74a62e263319044e158c72abd134c8c87a14444 @scottgonzalez scottgonzalez committed Aug 29, 2012
Showing with 178 additions and 0 deletions.
  1. +59 −0 entries/hide.xml
  2. +60 −0 entries/show.xml
  3. +59 −0 entries/toggle.xml
View
@@ -0,0 +1,59 @@
+<?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"/>
+</entry>
View
@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<entry name="show" type="method" return="jQuery">
+ <title>.show()</title>
+ <desc>Display 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>Show a div using the fold effect.</desc>
+ <css><![CDATA[
+ div {
+ display: none;
+ width: 100px;
+ height: 100px;
+ background: #ccc;
+ border: 1px solid #000;
+ }
+]]></css>
+ <html><![CDATA[
+<button>show the div</button>
+<div></div>
+]]></html>
+ <code><![CDATA[
+$( "button" ).click(function() {
+ $( "div" ).show( "fold", 1000 );
+});
+]]></code>
+ </example>
+ <category slug="methods"/>
+ <category slug="effects"/>
+</entry>
View
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<entry name="toggle" type="method" return="jQuery">
+ <title>.toggle()</title>
+ <desc>Display or 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>Toggle a div using the fold effect.</desc>
+ <css><![CDATA[
+ div {
+ width: 100px;
+ height: 100px;
+ background: #ccc;
+ border: 1px solid #000;
+ }
+]]></css>
+ <html><![CDATA[
+<button>toggle the div</button>
+<div></div>
+]]></html>
+ <code><![CDATA[
+$( "button" ).click(function() {
+ $( "div" ).toggle( "fold", 1000 );
+});
+]]></code>
+ </example>
+ <category slug="methods"/>
+ <category slug="effects"/>
+</entry>

0 comments on commit c74a62e

Please sign in to comment.