From c61c4ad5f9f9ca276c1872e0d95cf0e06934e649 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Wed, 25 Nov 2015 16:44:01 -0500 Subject: [PATCH 01/15] jQuery.effects.define: Initial docs --- entries/jQuery.effects.define.xml | 59 +++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 entries/jQuery.effects.define.xml diff --git a/entries/jQuery.effects.define.xml b/entries/jQuery.effects.define.xml new file mode 100644 index 00000000..f64dd490 --- /dev/null +++ b/entries/jQuery.effects.define.xml @@ -0,0 +1,59 @@ + + + + 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 animtion is complete.

+ + + + +]]> + + + + + + From 5ccdf07b1ac96e27ab8e4915a089765c73506366 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 09:10:06 -0500 Subject: [PATCH 02/15] fixup: typo --- entries/jQuery.effects.define.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.define.xml b/entries/jQuery.effects.define.xml index f64dd490..0e1ab888 100644 --- a/entries/jQuery.effects.define.xml +++ b/entries/jQuery.effects.define.xml @@ -17,7 +17,7 @@ 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 animtion is complete.

+

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.

 Date: Fri, 27 Nov 2015 09:54:38 -0500 Subject: [PATCH 03/15] fixup: Add return value --- entries/jQuery.effects.define.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/entries/jQuery.effects.define.xml b/entries/jQuery.effects.define.xml index 0e1ab888..1787c92d 100644 --- a/entries/jQuery.effects.define.xml +++ b/entries/jQuery.effects.define.xml @@ -1,6 +1,6 @@ - + jQuery.effects.define() @@ -18,6 +18,7 @@ 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.

 Date: Fri, 27 Nov 2015 09:54:59 -0500 Subject: [PATCH 04/15] jQuery.effects.scaledDimensions: Initial docs --- entries/jQuery.effects.scaledDimensions.xml | 23 +++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 entries/jQuery.effects.scaledDimensions.xml diff --git a/entries/jQuery.effects.scaledDimensions.xml b/entries/jQuery.effects.scaledDimensions.xml new file mode 100644 index 00000000..7af33444 --- /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.

+ + + + + From b94281459847d0816dea7c04434c63e03fa2744c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 11:07:54 -0500 Subject: [PATCH 05/15] jQuery.effects.clipToBox: Initial docs --- entries/jQuery.effects.clipToBox.xml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 entries/jQuery.effects.clipToBox.xml diff --git a/entries/jQuery.effects.clipToBox.xml b/entries/jQuery.effects.clipToBox.xml new file mode 100644 index 00000000..83136911 --- /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().

+ + + + + From 3c38d018d90814da243c33af084f8c34b38c7431 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 11:19:11 -0500 Subject: [PATCH 06/15] jQuery.effects.createPlaceholder: Initial docs --- entries/jQuery.effects.createPlaceholder.xml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 entries/jQuery.effects.createPlaceholder.xml diff --git a/entries/jQuery.effects.createPlaceholder.xml b/entries/jQuery.effects.createPlaceholder.xml new file mode 100644 index 00000000..be4ff2a7 --- /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 using 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.

+
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.
+ + + + + From cf5374a4fcdd44e3a4ad278d7101d3d2df8b14c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 11:28:58 -0500 Subject: [PATCH 07/15] jQuery.effects.removePlaceholder: Initial docs --- entries/jQuery.effects.createPlaceholder.xml | 2 +- entries/jQuery.effects.removePlaceholder.xml | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 entries/jQuery.effects.removePlaceholder.xml diff --git a/entries/jQuery.effects.createPlaceholder.xml b/entries/jQuery.effects.createPlaceholder.xml index be4ff2a7..7fd9e474 100644 --- a/entries/jQuery.effects.createPlaceholder.xml +++ b/entries/jQuery.effects.createPlaceholder.xml @@ -10,7 +10,7 @@ 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 using 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.

+

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.removePlaceholder.xml b/entries/jQuery.effects.removePlaceholder.xml new file mode 100644 index 00000000..d70ab9b8 --- /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.

+ + + + + From db22ff333edfbf665715f647ada208de262abad0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 11:31:16 -0500 Subject: [PATCH 08/15] fixup createPlaceholder: typo --- entries/jQuery.effects.createPlaceholder.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.createPlaceholder.xml b/entries/jQuery.effects.createPlaceholder.xml index 7fd9e474..be2786a5 100644 --- a/entries/jQuery.effects.createPlaceholder.xml +++ b/entries/jQuery.effects.createPlaceholder.xml @@ -9,7 +9,7 @@ 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 using 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.

+

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.
 From 20a173eece80687a93779c83d315703df50c3889 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 12:54:39 -0500 Subject: [PATCH 09/15] fixup clipToBox: spacing --- entries/jQuery.effects.clipToBox.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.clipToBox.xml b/entries/jQuery.effects.clipToBox.xml index 83136911..0300186e 100644 --- a/entries/jQuery.effects.clipToBox.xml +++ b/entries/jQuery.effects.clipToBox.xml @@ -1,6 +1,6 @@ - + jQuery.effects.clipToBox() From a25ed233ad23f1634c380ce2d3e0292e7fba4418 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 12:54:57 -0500 Subject: [PATCH 10/15] fixup createPlaceholder: spacing --- entries/jQuery.effects.createPlaceholder.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.createPlaceholder.xml b/entries/jQuery.effects.createPlaceholder.xml index be2786a5..93f47bad 100644 --- a/entries/jQuery.effects.createPlaceholder.xml +++ b/entries/jQuery.effects.createPlaceholder.xml @@ -1,6 +1,6 @@ - + jQuery.effects.createPlaceholder() From 9467ddd25386bc9913782562b47c0513ab6247ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 12:55:12 -0500 Subject: [PATCH 11/15] fixup removePlaceholder: spacing --- entries/jQuery.effects.removePlaceholder.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.removePlaceholder.xml b/entries/jQuery.effects.removePlaceholder.xml index d70ab9b8..b8b2c405 100644 --- a/entries/jQuery.effects.removePlaceholder.xml +++ b/entries/jQuery.effects.removePlaceholder.xml @@ -1,6 +1,6 @@ - + jQuery.effects.removePlaceholder() From 199f3bfba4774f618f3429d7b5e70d45e3272c4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 12:55:29 -0500 Subject: [PATCH 12/15] fixup scaledDimensions: spacing --- entries/jQuery.effects.scaledDimensions.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.scaledDimensions.xml b/entries/jQuery.effects.scaledDimensions.xml index 7af33444..6b714bc6 100644 --- a/entries/jQuery.effects.scaledDimensions.xml +++ b/entries/jQuery.effects.scaledDimensions.xml @@ -1,6 +1,6 @@ - + jQuery.effects.scaledDimensions() From cacc4140e0f819b8c5f657cc45f9e754f4d818b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 12:56:11 -0500 Subject: [PATCH 13/15] jQuery.effects.saveStyle: Initial docs --- entries/jQuery.effects.saveStyle.xml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 entries/jQuery.effects.saveStyle.xml diff --git a/entries/jQuery.effects.saveStyle.xml b/entries/jQuery.effects.saveStyle.xml new file mode 100644 index 00000000..1586b337 --- /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. + +

Saves all inline styles applied to an element. This is useful when animating various styles and restoring the existing styles at the end. The saved styles can be restored using jQuery.effects.restoreStyle().

+

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.

+ + + + + From 026a5539b9931bf55d0c8ef356df98b51a450283 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Fri, 27 Nov 2015 12:58:05 -0500 Subject: [PATCH 14/15] jQuery.effects.restoreStyle: Initial docs --- entries/jQuery.effects.restoreStyle.xml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 entries/jQuery.effects.restoreStyle.xml 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().

+ + + + + From 7dc40f7c928f82ee8aeeb575d9209ed2e960a83f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Scott=20Gonz=C3=A1lez?= Date: Wed, 2 Dec 2015 10:14:09 -0500 Subject: [PATCH 15/15] fixup: saveStyle --- entries/jQuery.effects.saveStyle.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entries/jQuery.effects.saveStyle.xml b/entries/jQuery.effects.saveStyle.xml index 1586b337..dce84fa2 100644 --- a/entries/jQuery.effects.saveStyle.xml +++ b/entries/jQuery.effects.saveStyle.xml @@ -9,7 +9,7 @@ Saves all inline styles applied to an element. -

Saves all inline styles applied to an element. This is useful when animating various styles and restoring the existing styles at the end. The saved styles can be restored using jQuery.effects.restoreStyle().

+

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.