UIZE JavaScript Framework

MODULES Uize.Fx

1. Introduction

The Uize.Fx module provides easy ways to initiate fades of CSS style properties, making a wide array of unique JavaScript animation effects possible.

DEVELOPERS: Chris van Rensburg

1.1. In a Nutshell

Using this module, colors can easily be animated, DOM nodes can be made to fly across the page, dimensions of objects can be morphed, and a whole array of other interesting effects can be achieved.

BACKGROUND READING

For an in-depth discussion on animation in the UIZE JavaScript Framework, and for a discussion on how this module fits into the larger picture, consult the guide JavaScript Animation and Effects and read through the section Animating CSS Style Properties.

1.2. Extensions For CSS3 Support

Support for fading the values of CSS3 style properties that are not yet universally supported by Web browsers is provided in the form of extension modules under the Uize.Fx namespace.

An example is the Uize.Fx.xShadows module, which provides support for fading values for the text-shadow and box-shadow CSS3 style properties.

1.3. Examples

The following example pages are good showcases for the Uize.Fx module...

Animate Position in JavaScript - See how to animate the position of an HTML element and how to apply amazingly realistic motion effects like easing, elasticity, bounce, and many more.
Animate Size in JavaScript - See how to animate the size of an HTML element and how to apply amazingly realistic physics effects like easing, elasticity, bounce, and many more.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Fx module...

SEARCH

1.4. Implementation Info

The Uize.Fx module defines the Uize.Fx package under the Uize namespace.

1.4.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

STATIC METHODS

Uize.Fx.defineStylePropertiesProfile | Uize.Fx.fadeStyle | Uize.Fx.fadeStyleAcrossNodes

STATIC PROPERTIES

Uize.Fx.moduleName | Uize.Fx.pathToResources

1.4.2. Features Overridden in This Module

No features have been overridden in this module.

1.4.3. Features Inherited From Other Modules

This module has no inherited features.

1.4.4. Modules Directly Under This Namespace

1.4.5. Unit Tests

There is no dedicated unit tests module for the Uize.Fx module.

2. Static Methods

2.1. Uize.Fx.defineStylePropertiesProfile

For advanced developers only, this is an extension hook that lets you extend the Uize.Fx module by adding support for fading of CSS style properties for which built-in support is not provided.

SYNTAX

Uize.Fx.defineStylePropertiesProfile (stylePropertiesProfileOBJ);

The Uize.Fx.defineStylePropertiesProfile method lets you define a profile for one or more CSS style properties, and such a profile will then allow values for those properties to be faded using the Uize.Fx.fadeStyle static method. Furthermore, any other modules that use the Uize.Fx.fadeStyle method in their implementation will also gain the benefit of supporting fading for those style properties.

As an example, the Uize.Fx.xShadows module uses the Uize.Fx.defineStylePropertiesProfile method to add support for the CSS3 text-shadow and box-shadow style properties. Once this module has been loaded, the Uize.Widget.HoverFader widget class, which uses the Uize.Fx.fadeStyle method in its implementation, will be able to support fading of text shadows and box shadows.

2.1.1. stylePropertiesProfileOBJ

A profile for one or more style properties is defined in the stylePropertiesProfileOBJ parameter.

The value of this parameter should be an object of the form...

{
  test              : testSTRorREGEXPorFUNC,  // property name test
  decoder           : decoderFUNC,            // value decoder function
  encoderExpression : encoderExpressionSTR,   // interpolated value encoder expression
  remappedProperty  : remappedPropertySTR     // remapped property name (optional)
}

2.1.1.1. test

A string, regular expression, or function, that will be used to determine if the profile applies to a specific style property.

A string value can be used to specify the exact name of a style property to which the profile applies. A regular expression can be used to match the profile to multiple style properties. A function can be used to provide a custom test that will be used to determine if the profile applies for a specific style property. A function value specified for this parameter should expect to receive a single parameter, being the name of a style property. The function should return true or false, depending on whether or not the profile supports the style property being tested.

LAST PROFILE WINS

The last profile that is defined and that tests positive for a specific style property will take over support for that property, even if a profile defined earlier had tested positive for that property and was providing support for it.

2.1.1.2. remappedProperty

An optional string, specifying a remapped name for the style property supported by the profile.

This property of the stylePropertiesProfileOBJ parameter can be useful in rare cases where the actual CSS style property to be faded needs to be different to the style property specified, such as with fading the value of the opacity style property in Internet Explorer. See the EXAMPLE: Opacity Profile below...

2.1.1.3. decoder

A function that is responsible for decoding the value of the style property and returning a value (possibly a compound value) that can be interpolated in the code of the Uize.Fade class.

If a compound value is returned, then the various interpolatable components of that compound value should be numbers. For example, a color type style property value can be decoded to produce a tuple array representing the components of the color. Decoding an RGB color value in this way would produce a color tuple with three elements, representing the values of the red, green, and blue components, respectively.

2.1.1.4. encoderExpression

A string, specifying an expression that can be used to encode the style property value that is interpolated in the code of the Uize.Fade class.

The specified expression string should contain the text "VALUE", which will be substituted, by the Uize.Fx.fadeStyle method, with a reference to the interpolated value for the style property. This is because the Uize.Fx.fadeStyle method can be used to fade the values of many style properties in a single fade process, and a larger compound value contains the values for all the individual style properties being faded. The encoder expression provided in your style properties profile will be combined together with the encodeer expressions for other style properties being faded and will then be compiled into a single function for improved performance.

2.1.2. Supporting Multiple Style Properties

In order to support multiple style properties, the test specified by the test property of the stylePropertiesProfileOBJ parameter should test positive for multiple style property names.

This, by definition, means that the value of the test property cannot be a string with a specific style property name, but should be either a regular expression or function. It also means that the remappedProperty property is not likely to be applicable, because you're not likely to want to map multiple different style property names to the same style property for fading. You should also only support multiple style properties with the same style properties profile if the value follows the same format for all the style properties.

See the EXAMPLE: Color Properties Profile for a demonstration of supporting multiple style properties.

2.1.3. EXAMPLE: Color Properties Profile

The following example shows a style properties profile that will support a large number of color type style properties...

EXAMPLE

Uize.Fx.defineStylePropertiesProfile ({
  test:/color|^background$/i,
  decoder:function (_value) {return Uize.Color.to (_value,'RGB array')},
  encoderExpression:'"rgb("+VALUE.join(",")+")"',
  quantization:1
});

Because we want to support a wide array of color style properties - such as color, background, backgroundColor, borderColor, borderTopColor, etc. - we use a regular expression for the test property of the stylePropertiesProfileOBJ parameter. The regular expression in this case will test positive for any style property name containing the word "color", and also for the background style property.

Our decoder takes the color style property value and turns it into an RGB tuple array using the Uize.Color.to method of the Uize.Color module and specifying the value 'RGB array' for its encodingSTR parameter. Our encoderExpression specifies an expression that constructs an rgb(...) formatted color value by joining the interpolated tuple array, represented by the "VALUE" token. Finally, to ensure that the values interpolated for the components of the RGB color tuple are integers, we specify the value 1 for the quantization property.

2.1.4. EXAMPLE: Opacity Profile

The following example shows a style properties profile that supports just the opacity style property...

EXAMPLE

Uize.Fx.defineStylePropertiesProfile ({
  test:'opacity',
  remappedProperty:Uize.Dom.Basics.isIe ? 'filter' : 'opacity',
  decoder:function (_value) {return +_value},
  encoderExpression:Uize.Dom.Basics.isIe
    ? '"alpha(opacity="+Math.round(VALUE*100)+")"'
    : 'VALUE'
});

Because we're only supporting the opacity style property in this profile, we can use the string value 'opacity' for the test property of the stylePropertiesProfileOBJ parameter. To deal with the fact that supporting opacity fades in Internet Explorer involves using the non-standard filter style property, we specify a value for the remappedProperty property of the stylePropertiesProfileOBJ parameter, where this value is conditionalized using the Uize.Dom.Basics.isIe static property.

The decoder is easy in this case - all our decoder function does is coerce the opacity property value to a number. Our encoder is also conditionalized, based upon whether or not we're dealing with Internet Explorer. For IE the expression constructs an alpha filter value for the non-standard filter style property, and for all other browsers the interpolated value is simply used as is. Finally, because opacity is interpolated as a floating point number in the range of 0 to 1, we don't specify any quantization property in this profile, which defaults the quantization to 0 for this profile.

2.1.5. More Examples of Style Properties Profiles

If you're looking to develop extension modules to support CSS style properties, you can look over the code of the Uize.Fx module (yes, this module), which contains style properties profiles for a variety of different style properties.

IMPLEMENTATION INFO

this feature was introduced in this module

2.2. Uize.Fx.fadeStyle

Lets you easily fade one or more CSS style properties for a specified node.

SYNTAX

fadeOBJ = Uize.Fx.fadeStyle (
  nodeSTRorOBJ,
  startStylePropertiesOBJ,
  endStylePropertiesOBJ,
  durationINT
);

The Uize.Fx.fadeStyle method supports fading values for the following CSS style properties...

color style properties: color, background, backgroundColor, borderColor, borderTopColor, borderRightColor, borderBottomColor, borderLeftColor
position style properties: top, right, bottom, left, backgroundPosition
padding and margin style properties: padding, paddingTop, paddingRight, paddingBottom, paddingLeft, margin, marginTop, marginRight, marginBottom, marginLeft
dimension style properties: width, height, maxWidth, maxHeigh, borderWidth, borderTopWidth, borderRightWidth, borderBottomWidth, borderLeftWidth
font style properties: fontSize, letterSpacing, wordSpacing, lineHeight, textIndent

EXAMPLES

// fade from thin border/thick padding to thick border/thin padding over 1/4 second
Uize.Fx.fadeStyle ('myNode',{borderWidth:1,padding:20},{borderWidth:20,padding:1},250);

// fade from current colors to white text on black background over two seconds
Uize.Fx.fadeStyle ('myNode',null,{color:'#fff',backgroundColor:'#000'},2000);

// fade font size from 30px back to current size over a half second
Uize.Fx.fadeStyle ('myNode',{fontSize:30},null,500);

IMPORTANT

The naming of style properties in the style properties objects for the startStylePropertiesOBJ and endStylePropertiesOBJ parameters should use the DOM reflected (ie. camelCased) names rather than the CSS format names. For example, the CSS style property border-left-color is reflected in the DOM as borderLeftColor.

VARIATION 1

fadeOBJ = Uize.Fx.fadeStyle (
  nodeSTRorOBJ,
  startStylePropertiesOBJ,
  endStylePropertiesOBJ,
  durationINT,
  fadePropertiesOBJ
);

When the optional fadePropertiesOBJ parameter is specified, additional values can be specified for the state properties of the Uize.Fade class - such as curve, quantization, etc. These property values will be set on the Uize.Fade instance that is created to service the fade process requested by calling this method.

VARIATION 2

fadeOBJ = Uize.Fx.fadeStyle (
  nodeSTRorOBJ,
  startStylePropertiesOBJ,
  endStylePropertiesOBJ,
  durationINT,
  fadePropertiesOBJ,
  startNowBOOL
);

By default, fades created using the Uize.Fade.fadeStyle method are started immediately. If you do not wish the fade to start immediately, but wish to initiate the fade at a later time by using the start instance method of the Uize.Fade instance returned from the Uize.Fade.fadeStyle method, then you can specify the value false for the optional startNowBOOL parameter. If you wish to use the startNowBOOL parameter but do not wish to specify any fade properties, then you should specify the value null for the fadePropertiesOBJ parameter.

2.2.1. Fading Clip Region

The Uize.Fx.fadeStyle method can be used to fade the value of the clip style property.

With the Uize.Fx.fadeStyle method, values for the clip style property can be specified in a variety of ways, as illustrated by the examples below...

// as a correct string value, according to CSS spec

{clip:'rect (0px , 200px , 100px , 0px)'}
{clip:'rect(0px, 200px, 100px, 0px)'}
{clip:'rect(0px,200px,100px,0px)'}

// as a string value, with a measure of forgiveness

{clip:'rect(0px 200px 100px 0px)'}
{clip:'rect(0px200px100px0px)'}
{clip:'rect(0 200 100 0)'}
{clip:'rect(0,200,100,0)'}

// as a string, with no "rect(...)" wrapper

{clip:'0px 200px 100px 0px'}
{clip:'0px, 200px, 100px, 0px'}
{clip:'0px,200px,100px,0px'}
{clip:'0px200px100px0px'}
{clip:'0 200 100 0'}
{clip:'0,200,100,0'}

// as an array with four elements

{clip:['0px','200px','100px','0px']}
{clip:['0','200','100','0']}
{clip:[0,200,100,0]}

2.2.2. Fading Opacity

The Uize.Fx module supports fading of the opacity style property.

This module deals with the difference between Internet Explorer and browsers that support the CSS standard opacity style property. For IE, the proprietary filter style property is used, but as a developer you can specify opacity as if it were supported by IE.

EXAMPLES

Uize.Fx.fadeStyle ('myNode',null,{opacity:0});        // from current to transparent
Uize.Fx.fadeStyle ('myNode',{opacity:0},{opacity:1}); // from transparent to opaque

2.2.3. Specifying Color Values

The Uize.Fx.fadeStyle method supports a wide variety of ways for specifying values for color CSS style properties.

Basically, color values can be specified in any way that a color can be specified when using the single parameter variations of the Uize.Color constructor. For example, the following statements would all fade the background color of the node "myNode" from the current color to white...

EXAMPLES

Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:'#fff'});
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:'#ffffff'});
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:'f'});
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:'Rgb(255,255,255)');
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:{red:255,green:255,blue:255});
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:[255,255,255]});
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:Uize.Color (255)});
Uize.Fx.fadeStyle ('myNode',null,{backgroundColor:255});

NOTES

see the related Uize.Fx.fadeStyleAcrossNodes static method

IMPLEMENTATION INFO

this feature was introduced in this module

2.3. Uize.Fx.fadeStyleAcrossNodes

Lets you easily fade values for an arbitrary number of CSS style properties across a specified series of nodes.

SYNTAX

Uize.Fx.fadeStyleAcrossNodes (
  findExpressionOBJ,
  startStylePropertiesOBJ,
  endStylePropertiesOBJ
);

This method produces a style fade across a series of nodes, rather than over a period of time like the related Uize.Fx.fadeStyle static method. Using this method, you can easily produce color gradients that span multiple nodes by fading the values of the color, backgroundColor, borderColor, and other color style properties. You can just as easily create size and position graduations in order to arrange and scale HTML elements in a continuous fashion. Other CSS style properties, such as padding, margin, fontSize, letterSpacing, wordSpacing, lineHeight, textIndent, etc. can also be faded across a series of nodes. And, when loading in extension modules that provide support for additional CSS style properties, such as the Uize.Fx.xShadows module that provides support for the text-shadow and box-shadow CSS3 style properties, such style properties can also be faded across nodes.

With the ability to apply curve functions discretely to different properties in a style fade, complex and compelling non-linear style fades can be created. To get a taste of the wide variety of different effects that can be achieved using this method, see the example Fade CSS Style Across Nodes.

2.3.1. findExpressionOBJ

An object, specifying the series of nodes across which the CSS style fade should be applied.

The value of the findExpressionOBJ parameter is resolved to an array of nodes using the Uize.Dom.Basics.find static method that is implemented in the Uize.Dom.Basics module. This means that any facilities provided by that method are available when specifying nodes in a call to the Uize.Fx.fadeStyleAcrossNodes method. If you already have an array of nodes, then this array can be supplied as the value of the findExpressionOBJ parameter.

2.3.2. startStylePropertiesOBJ

An object, specifying the start values for an arbitrary number of CSS style properties.

The style property values specified in the startStylePropertiesOBJ parameter will be applied to the first node in the series of nodes specified by the findExpressionOBJ parameter (unless you specify the value true for the reverse property in the optional fadePropertiesOBJ parameter).

2.3.3. endStylePropertiesOBJ

An object, specifying the end values for an arbitrary number of CSS style properties.

The style property values specified in the endStylePropertiesOBJ parameter will be applied to the last node in the series of nodes specified by the findExpressionOBJ parameter (unless you specify the value true for the reverse property in the optional fadePropertiesOBJ parameter).

2.3.4. Start and End Style Structures Must Match

Whatever style property values are specified in the startStylePropertiesOBJ object, values for those same style properties should also be specified in the endStylePropertiesOBJ parameter, so the structures of these two parameters should be the same.

This rule also applies to style properties that can have compound values, such as textShadow. For example, if the value of the textShadow property specified in the startStylePropertiesOBJ parameter defines three shadows, then the value of the textShadow property specified in the endStylePropertiesOBJ parameter should also define three shadows. Moreover, the structure of the corresponding shadow definitions should match between the start value and the end value. For instance, the unit used for specifying the optional blur radius should be the same for the same shadow between the start and end values for textShadow. Similarly, if shadow color is specified for a shadow in the start value, then shadow color should also be specified for the corresponding shadow in the end value.

2.3.5. fadePropertiesOBJ

When the optional fadePropertiesOBJ parameter is specified, additional values can be specified for the state properties of the Uize.Fade class - such as curve, quantization, etc.

VARIATION

Uize.Fx.fadeStyleAcrossNodes (
  findExpressionOBJ,
  startStylePropertiesOBJ,
  endStylePropertiesOBJ,
  fadePropertiesOBJ
);

The fade property values specified in the optional fadePropertiesOBJ parameter will be set on the Uize.Fade instance that is created for the style fade. One compelling use of the fadePropertiesOBJ parameter is to use it to specify a curve function, so that a style fade can be non-linear.

2.3.6. An Example

To get a better idea of how the Uize.Fx.fadeStyleAcrossNodes works, let's consider an example...

EXAMPLE

Uize.Fx.fadeStyleAcrossNodes (
  {className:/\bmenuLink\b/},
  {
    color:'efe',
    backgroundColor:'9aa',
    borderColor:'bcb',
    textShadow:'#0 2 2 3'
  },
  {
    color:'899',
    backgroundColor:'234',
    borderColor:'345',
    textShadow:'#0 2 2 3'
  }
)

In the above example, a color gradient is being applied to all the nodes that make up a navigation menu. The series of nodes across which CSS style is being faded is specified using the find expression {className:/\bmenuLink\b/}. This expression finds all nodes that contain the CSS class "menuLink" in their class attribute (the \b in the regular expression indicates a word boundary).

The color gradient being applied across the menu nodes is fading the color values of the color, backgroundColor, and borderColor style properties. In addition, a text shadow is being applied to all the nodes, but the properties of the text shadow are not changing across the nodes - it's just a basic drop shadow. The particular color gradient represented by the above style fade statement would result in the first node in the series being a light greenish gray, and the last node in the series being a dark blueish gray. Nodes between the first and last nodes would be blends of gray that are between the light gray and the dark gray.

NOTES

see the related Uize.Fx.fadeStyle static method

IMPLEMENTATION INFO

this feature was introduced in this module

3. Static Properties

3.1. Uize.Fx.moduleName

IMPLEMENTATION INFO

this feature was introduced in this module

3.2. Uize.Fx.pathToResources

IMPLEMENTATION INFO

this feature was introduced in this module