diff --git a/entries/jQuery.effects.clipToBox.xml b/entries/jQuery.effects.clipToBox.xml new file mode 100644 index 00000000..0300186e --- /dev/null +++ b/entries/jQuery.effects.clipToBox.xml @@ -0,0 +1,17 @@ + + + + jQuery.effects.clipToBox() + + + A set of properties that will eventually be passed to .animate(). The animationProperties must contain a clip property. + + + Calculates position and dimensions based on a clip animation. + +

This method is useful for mimicking a clip animation when using a placeholder for effects. Given a clip animation, jQuery.effects.clipToBox() will generate an object containing top, left, width, and height properties which can be passed to .css() or .animate(). This method is generally used in conjunction with jQuery.effects.createPlaceholder().

+ + + + + diff --git a/entries/jQuery.effects.createPlaceholder.xml b/entries/jQuery.effects.createPlaceholder.xml new file mode 100644 index 00000000..93f47bad --- /dev/null +++ b/entries/jQuery.effects.createPlaceholder.xml @@ -0,0 +1,19 @@ + + + + jQuery.effects.createPlaceholder() + + + The element to create a placeholder for. + + + Creates a placeholder to support clip animations without disrupting the layout. + +

Many effects require animating the clip CSS property. In order to apply clipping, the element must be absolutely positioned. As a result, if an animation that utilizes clipping is applied to an element with static or relative positioning, the layout of the page will be affected when the animated element is removed from the flow. To compensate for this, a placeholder element with the same size and position can be inserted into the document.

+

jQuery.effects.createPlaceholder() will create a placeholder with the same display, position, dimensions, and margins as the original element. The placeholder is inserted into the DOM as the next sibling of the original element. When the animation is complete, jQuery.effects.removePlaceholder() should be used to remove the inserted element.

+
If the original element is already absolutely positioned, no placeholder will be generated since the page layout isn't affected. As a result, the return value will be undefined.
+ + + + + diff --git a/entries/jQuery.effects.define.xml b/entries/jQuery.effects.define.xml new file mode 100644 index 00000000..1787c92d --- /dev/null +++ b/entries/jQuery.effects.define.xml @@ -0,0 +1,60 @@ + + + + jQuery.effects.define() + + + The name of the effect to create. + + + The default mode for the effect. Possible values are "show", "hide", or "toggle". + + + + + Defines the effect logic. The options argument contains duration and mode properties, as well as any effect-specific options. + + + Defines an effect. + +

Defines a new effect for use with .effect(), .show(), .hide(), and .toggle(). The effect method is invoked with this being a single DOM element. The done argument must be invoked when the animation is complete.

+

jQuery.effects.define() stores the new effect in jQuery.effects.effect[ name ] and returns the function that was provided as the effect parameter.

+ + + + +]]> + + + + + + diff --git a/entries/jQuery.effects.removePlaceholder.xml b/entries/jQuery.effects.removePlaceholder.xml new file mode 100644 index 00000000..b8b2c405 --- /dev/null +++ b/entries/jQuery.effects.removePlaceholder.xml @@ -0,0 +1,17 @@ + + + + jQuery.effects.removePlaceholder() + + + The original element that has an associated placeholder. + + + Removes a placeholder created with jQuery.effects.createPlaceholder(). + +

Removes the placeholder for an element. This method is safe to call even if jQuery.effects.createPlaceholder() did not create a placeholder.

+ + + + + diff --git a/entries/jQuery.effects.restoreStyle.xml b/entries/jQuery.effects.restoreStyle.xml new file mode 100644 index 00000000..ce6e3d0b --- /dev/null +++ b/entries/jQuery.effects.restoreStyle.xml @@ -0,0 +1,17 @@ + + + + jQuery.effects.restoreStyle() + + + The element to restore styles for. + + + Restores all inline styles for an element. + +

Restores all inline styles for an element which have been saved using jQuery.effects.saveStyle().

+ + + + + diff --git a/entries/jQuery.effects.saveStyle.xml b/entries/jQuery.effects.saveStyle.xml new file mode 100644 index 00000000..dce84fa2 --- /dev/null +++ b/entries/jQuery.effects.saveStyle.xml @@ -0,0 +1,18 @@ + + + + jQuery.effects.saveStyle() + + + The element to save styles for. + + + Saves all inline styles applied to an element. + +

Stores a copy of the current inline styles applied to the element, which can be reapplied to the element later using jQuery.effects.restoreStyle(). This is useful when animating various styles and restoring the existing styles at the end.

+

When using jQuery.effects.define() to create an effect, if jQuery.effects.saveStyle() is used on the main element being animated, the styles will be restored automatically when the animation is complete.

+ + + + + diff --git a/entries/jQuery.effects.scaledDimensions.xml b/entries/jQuery.effects.scaledDimensions.xml new file mode 100644 index 00000000..6b714bc6 --- /dev/null +++ b/entries/jQuery.effects.scaledDimensions.xml @@ -0,0 +1,23 @@ + + + + jQuery.effects.scaledDimensions() + + + The element to scale. + + + The percentage of the original size that the element's dimensions should be scaled to. + + + Which direction to scale the element's dimensions; either "horizontal" or "vertical". If direction is omitted, both dimensions will be scaled. + + + Scales the dimensions of an element. + +

This method scales the dimensions of an element, returning an object containing height, width, outerHeight, and outerWidth properties. The element is not actually modified.

+ + + + +