Skip to content

1-12 preview #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 29 commits into from
Closed

1-12 preview #283

Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
fcd1c98
Selectmenu: Add documentation for _renderButtonItem() extension point
fnagel Sep 2, 2014
1a0b17d
Tooltip: Document extended content option
jzaefferer Jan 12, 2015
733dc92
Menu: Document the new wrapper requirement
tjvantoll Nov 7, 2014
7441173
Effects: Clean up queue wording since we don't support jQuery <1.7
scottgonzalez Feb 24, 2015
2ffda1e
Interactions: distance and delay options are deprecated
scottgonzalez Feb 24, 2015
19b3987
Selectmenu: Document changes to width option
scottgonzalez Mar 4, 2015
a0912d1
CSS Framework: Updated section about shadow
jaspermdegroot Jan 22, 2015
ad42c59
Stacking Elements: Remove hard wrapping
scottgonzalez Mar 27, 2015
c1fef18
Stacking Elements: Consider `<dialog>` a stacking element
scottgonzalez Mar 27, 2015
9743a95
All: Document classes option
jzaefferer Mar 19, 2015
965db7e
Entries: Mark deprecated options
jzaefferer Apr 20, 2015
29b1f74
Effects: Mark transfer-effect deprecated, document .transfer()
jzaefferer Apr 22, 2015
75ebb4d
Entries: Make deprecations more useful
jzaefferer Apr 23, 2015
031bf52
Slider: Document new handleIndex property on all 4 events
jzaefferer Apr 22, 2015
9be8fc0
Size Effect: Document behaviour for .show() and .toggle() methods
jzaefferer Apr 24, 2015
e59e812
Entries: Document cssClip method
jzaefferer Apr 24, 2015
62d61c4
Entries: Document $.fn.labels
jzaefferer May 7, 2015
f093eb5
Position: Move <added> info onto the signature
jzaefferer May 7, 2015
f3f6afd
Focus: Deprecated focus override is gone in 1.12
jzaefferer Sep 30, 2015
f49070e
Button: Document rewrite, deprecate buttonset, document new widgets
jzaefferer Sep 30, 2015
559287c
FormResetMixin: Initial API documentation for new mixin
jzaefferer Oct 25, 2015
0b8e35c
jQuery.effects.define: Initial docs
scottgonzalez Nov 25, 2015
4b85611
jQuery.effects.scaledDimensions: Initial docs
scottgonzalez Nov 27, 2015
6ba1642
jQuery.effects.clipToBox: Initial docs
scottgonzalez Nov 27, 2015
5f0e014
jQuery.effects.createPlaceholder: Initial docs
scottgonzalez Nov 27, 2015
316d99b
jQuery.effects.removePlaceholder: Initial docs
scottgonzalez Nov 27, 2015
eb54654
jQuery.effects.saveStyle: Initial docs
scottgonzalez Nov 27, 2015
867fb9f
jQuery.effects.restoreStyle: Initial docs
scottgonzalez Nov 27, 2015
89eaae6
jQuery.effects.saveStyle: Update description
scottgonzalez Dec 3, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
jQuery.effects.define: Initial docs 
Ref gh-242
Ref gh-288
  • Loading branch information
@scottgonzalez
scottgonzalez committed Dec 17, 2015
commit 0b8e35c4321af969ff79cb1d9d2f550dc6dc68a6
60 changes: 60 additions & 0 deletions entries/jQuery.effects.define.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?xml version="1.0"?>
<entries>
<entry type="method" name="jQuery.effects.define" return="Function" added="1.12">
<title>jQuery.effects.define()</title>
<signature>
<argument name="name" type="String">
<desc>The name of the effect to create.</desc>
</argument>
<argument name="mode" type="String" optional="true">
<desc>The default mode for the effect. Possible values are <code>"show"</code>, <code>"hide"</code>, or <code>"toggle"</code>.</desc>
</argument>
<argument name="effect" type="Function">
<argument name="options" type="Object"/>
<argument name="done" type="Function"/>
<desc>Defines the effect logic. The <code>options</code> argument contains <code>duration</code> and <code>mode</code> properties, as well as any effect-specific options.</desc>
</argument>
</signature>
<desc>Defines an effect.</desc>
<longdesc>
<p>Defines a new effect for use with <a href="/effect/"><code>.effect()</code></a>, <a href="/show/"><code>.show()</code></a>, <a href="/hide/"><code>.hide()</code></a>, and <a href="/toggle/"><code>.toggle()</code></a>. The effect method is invoked with <code>this</code> being a single DOM element. The <code>done</code> argument must be invoked when the animation is complete.</p>
<p><code>jQuery.effects.define()</code> stores the new effect in <code>jQuery.effects.effect[ name ]</code> and returns the function that was provided as the <code>effect</code> parameter.</p>
</longdesc>
<example>
<css><![CDATA[
.elem {
position: absolute;
width: 150px;
height: 150px;
background: #3b679e;
}
]]></css>
<html><![CDATA[
Click anywhere!
<div class="elem"></div>
]]></html>
<code><![CDATA[
$.effects.define( "fade", "toggle", function( options, done ) {
var show = options.mode === "show";

$( this )
.css( "opacity", show ? 0 : 1 )
.animate( {
opacity: show ? 1 : 0
}, {
queue: false,
duration: options.duration,
easing: options.easing,
complete: done
} );
} );

$( document ).on( "click", function() {
$( ".elem" ).toggle( "fade" );
} );
]]></code>
</example>
<category slug="effects-core"/>
<category slug="effects"/>
</entry>
</entries>