UIZE JavaScript Framework

MODULES Uize.Widget.HoverFader

1. Introduction

The Uize.Widget.HoverFader class wires up a set of nodes with a hover fader effect, allowing creation of menus with a wide variety of complex effects.

DEVELOPERS: Chris van Rensburg

1.1. All in the Set

The entire interface for the Uize.Widget.HoverFader class is exposed through its state properties.

There are no special methods for this class. All methods and other properties are inherited from the Uize.Widget base class. All that one does in order to utilize this widget is to instantiate it with the desired settings.

1.2. Fading CSS Style Properties

The Uize.Widget.HoverFader class is flexible enough to enable a healthy array of CSS style property fade effects.

Many of the CSS style properties can be faded using this class, including...

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

NOTES

values for color style properties can be specified in single digit, three digit, or six digit hex RGB format - with or without the "#" (hash / pound sign) prefix
values for position and dimension style properties can be specified as strings with the "px" suffix (eg. '100px') or simply as numbers (eg. 100)

Configurable fade properties let you control the rate of the fade-in independently of the rate of the fade-out, and any other state properties of the Uize.Fade class (such as curve) can be specified for both the fade-in and fade-out.

1.3. Any Nodes

The nodes that you wire up with this widget can be of any type: links, divs, spans, etc.

Each instance of the Uize.Widget.HoverFader class manages the hover fade effect for a set of nodes. The class doesn't much care what the relationship between the nodes is. They can be clumped together in the layout in the form of a set of menu links, or they can be inline links interspersed throughout a paragraph, or just plain old anywhere. To supply the class with your nodes, you can use any means for gathering those nodes. One approach would be to use the Uize.Dom.Basics.find static method to find nodes that match given criteria - such as class name, or tag type, or a combination thereof.

1.4. Progressive Enhancement

The Uize.Widget.HoverFader widget class falls into the category of Progressive Enhancement (or "unobtrusive JavaScript") widgets.

HTML that is enhanced with this widget will still function if the widget fails to wire, some library module fails to load, or JavaScript is disabled. The widget instance becomes essentially a vehicle for storing the effect configuration for the group of nodes that it manages, and doesn't present its own UI. Using the widget architecture also allows the behavior to be unwired using the unwireUi instance method.

1.5. An Example

The example below demonstrates how a set of menu links could be wired with a hover color fade effect.

EXAMPLE

page.addChild (
  'menuHoverFader',
  Uize.Widget.HoverFader,
  {
    nodes:Uize.Dom.Basics.find ({root:'menu',className:/\bmenuLink\b/}),
    defaultStyle:{color:'bbb',backgroundColor:'000',borderColor:'555'},
    hoverStyle:{color:'fff',backgroundColor:'77a',borderColor:'000'},
    fadeIn:{duration:500,curve:Uize.Fade.celeration (0,1)},
    fadeOut:{duration:750,curve:Uize.Fade.celeration (1,0)}
  }
);

In the above example, the Uize.Widget.HoverFader instance is being added as a child widget to a page widget instance, so the effect will be wired up when the page widget instance is wired. The value for the nodes state property specifies the nodes that should be wired up with the effect. The nodes being supplied in this case are obtained through a call to the Uize.Dom.Basics.find static method. Based on the options specified in the call, the Uize.Dom.Basics.find method will find all nodes with a class name of "menuLink" that are in a node tree with a node of the id "menu" at its root.

The defaultStyle state property specifies the color style property values for the default state of the nodes (ie. when not mousing over them), in this case light gray text on a black background with a dark gray border. The hoverStyle state property specifies the color style property values for the hover state of the nodes (ie. when mousing over them), in this case white text on a pastel blue background with a black border.

The fadeIn state property specifies properties for the fade process that is used to fade the node that is currently being moused over from the defaultStyle styling to the hoverStyle styling, in this case with a duration of 500 milliseconds and accelerating through the entire fade. The fadeOut state property specifies properties for the fade process that is used to fade the node that is currently being moused out of from the hoverStyle styling back to the defaultStyle styling, in this case with a duration of 750 milliseconds and accelerating through the entire fade. A greater duration for the fade-out will result in a lingering trail, and the acceleration will accentuate this quality.

1.6. Examples

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

Animated Buttons with Box Shadow - See how to animate CSS3 box-shadow in order to make buttons leap out of the page when you mouse over them and bounce back when you mouse out of them.
Fading Links - Elegant menu animation effects to liven up any dull Web page! This JavaScript example shows you what is possible with the UIZE JavaScript Framework.
Hover Fader Color Effects - Who needs boring menus when you can have stunning menu animations that will have your users mesmerized! You have to see these effects to believe them.
Hover Fader Stretching Menu - Stretch the limits of what can be done with animated menus. Using JavaScript to animate CSS style properties can produce amazingly slick effects!
Hover Fader Text Shadow Animation - Animate the color, horizontal offset, vertical offset, and blur radius properties for any number of CSS3 text shadows to produce amazing menu effects.
Hover Fader for Thumbnails - See how to liven up image thumbnails with some cool JavaScript animation! Diverse effects can be achieved by animating different CSS style properties.

SEARCH FOR EXAMPLES

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

SEARCH

1.7. Implementation Info

The Uize.Widget.HoverFader module defines the Uize.Widget.HoverFader class, which is a subclass of Uize.Widget.

INHERITANCE CHAIN

Uize.Class −> Uize.Widget −> Uize.Widget.HoverFader

1.7.1. Features Introduced in This Module

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

INSTANCE METHODS

tickle

STATE PROPERTIES

defaultStyle | fadeIn | fadeInOut | fadeOut | hoverStyle | nodes

1.7.2. Features Overridden in This Module

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

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

valueOf | wireUi

STATIC METHODS

Uize.Widget.HoverFader.valueOf

STATIC PROPERTIES

Uize.Widget.HoverFader.moduleName | Uize.Widget.HoverFader.nonInheritableStatics

1.7.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

addChild | addChildren | ajax | buildHtml | callInherited | childId | confirm | displayNode | fire | flushNodeCache | get | getContainer | getHtml | getInherited | getNode | getNodeStyle | getNodeValue | getProvider | globalizeNode | inform | injectNodeHtml | insertOrWireUi | insertUi | is | isMet | kill | localize | met | nodeId | onChange | once | removeChild | removeNode | removeUi | set | setInherited | setNodeClipRect | setNodeInnerHtml | setNodeOpacity | setNodeProperties | setNodeStyle | setNodeValue | showNode | toggle | unmet | unwire | unwireNode | unwireNodeEventsByMatch | unwireUi | updateUi | whenever | wire | wireNode

INSTANCE PROPERTIES

showConfirm | showInform

STATE PROPERTIES

built | busy | busyInherited | children | container | enabled | enabledInherited | html | idPrefix | idPrefixConstruction | insertionMode | localized | name | nodeMap | wired

STATIC METHODS

Uize.Widget.HoverFader.alphastructor | Uize.Widget.HoverFader.declare | Uize.Widget.HoverFader.doMy | Uize.Widget.HoverFader.dualContextMethods | Uize.Widget.HoverFader.dualContextProperties | Uize.Widget.HoverFader.fire | Uize.Widget.HoverFader.get | Uize.Widget.HoverFader.getBlankImageUrl | Uize.Widget.HoverFader.instanceMethods | Uize.Widget.HoverFader.instanceProperties | Uize.Widget.HoverFader.mixins | Uize.Widget.HoverFader.omegastructor | Uize.Widget.HoverFader.set | Uize.Widget.HoverFader.singleton | Uize.Widget.HoverFader.spawn | Uize.Widget.HoverFader.stateProperties | Uize.Widget.HoverFader.staticMethods | Uize.Widget.HoverFader.staticProperties | Uize.Widget.HoverFader.subclass | Uize.Widget.HoverFader.toggle | Uize.Widget.HoverFader.treeInheritedStateProperties | Uize.Widget.HoverFader.unwire | Uize.Widget.HoverFader.wire

STATIC PROPERTIES

Uize.Widget.HoverFader.busyInherited | Uize.Widget.HoverFader.enabledInherited | Uize.Widget.HoverFader.isWired | Uize.Widget.HoverFader.pathToResources

1.7.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.7.5. Unit Tests

There is no dedicated unit tests module for the Uize.Widget.HoverFader module.

2. Instance Methods

2.1. addChild

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.2. addChildren

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.3. ajax

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.4. buildHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.5. callInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.6. childId

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.7. confirm

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.8. displayNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.9. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.10. flushNodeCache

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.11. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.12. getContainer

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.13. getHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.14. getInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.15. getNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.16. getNodeStyle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.17. getNodeValue

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.18. getProvider

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.19. globalizeNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.20. inform

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.21. injectNodeHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.22. insertOrWireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.23. insertUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.24. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.25. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.26. kill

Inherited from Uize.Widget, but introduced in Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Class)

2.27. localize

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.28. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.29. nodeId

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.30. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.31. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.32. removeChild

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.33. removeNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.34. removeUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.35. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.36. setInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.37. setNodeClipRect

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.38. setNodeInnerHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.39. setNodeOpacity

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.40. setNodeProperties

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.41. setNodeStyle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.42. setNodeValue

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.43. showNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.44. tickle

Lets you initiate a "tickling" of the nodes of the instance, emulating the effect of the user moving their mouse across the nodes.

SYNTAX

myInstance.tickle (intervalINT);

The intervalINT parameter lets you specify an interval, measured in milliseconds, between triggering of the fade-outs for the different nodes of the instance.

VARIATION 1

myInstance.tickle ();

When no intervalINT parameter is specified, then its value will be defaulted to 100.

VARIATION 2

myInstance.tickle (fadePropertiesOBJ);

When the fadePropertiesOBJ parameter is specified in place of the intervalINT parameter, then an object containing fade properties (ie. state properties of the Uize.Fade class) can be specified to configure the fade that drives the tickling of the nodes.

Among other things, this allows one to specify a curve property for the fade, so that the timing of the triggering of the fade-outs for the different nodes of the instance is not uniform. In addition, one can use the reverse fade property to control the order in which the tickling occurs. Specifying the value true for the reverse fade property will cause the tickling to start with the last node and end at the first node.

When using this parameter, it is not possible to specify an interval between triggering the different nodes. Instead, one specifies the duration of the overal tickling process in the duration fade property. Because a non-linear curve can be specified, a single interval value is not meaningful, anyway.

EXAMPLE 1

myHoverFader.tickle ({duration:1000});

In the above example, the nodes of the instance myHoverFader are being tickled over a period of 1000 milliseconds (1 second). Specifying the fadePropertiesOBJ parameter in place of the intervalINT parameter lets you control the overal duration of the tickling process with the duration fade property. The number of nodes can change, but the overal duration of the tickling will remain the same. By contrast, the overal duration would change as the number of nodes changes when using the intervalINT paramter.

EXAMPLE 2

myHoverFader.tickle ({duration:1000,reverse:true,curve:Uize.Curve.resolve (-3)});

In the above example, the nodes of the instance myHoverFader are being tickled over a period of 1000 milliseconds (1 second), starting from the last node and ending at the first node, and starting out slowly and accelerating towards the end (the expression Uize.Curve.resolve (-3) creates a cubic ease-in curve function).

IMPLEMENTATION INFO

this feature was introduced in this module

2.45. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.46. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.47. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.48. unwireNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.49. unwireNodeEventsByMatch

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.50. unwireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.51. updateUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.52. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

2.53. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.54. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

2.55. wireNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

2.56. wireUi

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget)

3. State Properties

3.1. built

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.2. busy

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.3. busyInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.4. children

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.5. container

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.6. defaultStyle

An object, whose properties specify the values for CSS style properties at the start of the hover fade-in (and also the end of the hover fade-out).

EXAMPLE VALUE

{
  width:'110px',
  borderLeftWidth:'1px',
  color:'bbb',           // light gray
  backgroundColor:'000', // black
  borderColor:'555'      // dark gray
}

The defaultStyle object may contain values for any of the supported CSS style properties (see the section Fading CSS Style Properties). The structure of the object should match the structure of the companion hoverStyle state property's value, or the effect will not work correctly. In other words, if the defaultStyle object contains a value for borderColor, then the hoverStyle object must also contain a value for this style property.

For a more complete example of how this state property is used in conjunction with other state properties, consult the section An Example.

NOTES

for best effect, style property values specified in this property should match the initial style property values for the nodes (as determined by stylesheet rules for your page)
see the companion hoverStyle state property
the initial value is {color:'fff',backgroundColor:'000'}

IMPLEMENTATION INFO

this feature was introduced in this module

3.7. enabled

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.8. enabledInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.9. fadeIn

An object, specifying fade properties for the fade-in phase (ie. when mousing over a node) of the hover fade effect.

If the default fade-in duration does not suit your needs, you should at least use this property to configure a suitable duration. Any valid state properties of the Uize.Fade class (such as curve) can be specified in the fadeIn object, and these values will be applied when the fade-in starts.

EXAMPLE VALUE

{
  duration:500,
  curve:Uize.Fade.celeration (1,0)
}

NOTES

see the companion fadeInOut and fadeOut state properties
the initial value is {duration:250}

IMPLEMENTATION INFO

this feature was introduced in this module

3.10. fadeInOut

An object, specifying fade properties that are common to both the fade-in phase (ie. when mousing over a node) and the fade-out phase (ie. when mousing out of a node) of the hover fade effect.

EXAMPLE

page.addChild (
  'menuHoverFader',
  Uize.Widget.HoverFader,
  {
    defaultStyle:{color:'b',backgroundColor:'0'},
    hoverStyle:{color:'0',backgroundColor:'f'},
    fadeInOut:{
      curve:{
        backgroundColor:[
          Uize.Curve.Mod.band (1,.5,0),
          Uize.Curve.Mod.band (1,.5,.5),
          Uize.Curve.Mod.band (1,.5,1)
        ]
      }
    },
    fadeIn:{duration:500},
    fadeOut:{duration:1250}
  }
);

In the above example, a Uize.Widget.HoverFader instance is being added to the page widget as a child widget named menuHoverFader. The fadeInOut state property is being used to specify fade properties that are common to both the fade-in and fade-out phases of the hover fade effect.

These settings achieve a "hot" fade from black to white (and vice versa), where the background color transitions through shades of reds and yellows. This is accomplished by specifying different curve functions for the red, green, and blue components of the color tuple for the backgroundColor CSS style property. Now, because we want the fade-in to be faster than the fade-out, we are using the fadeIn and fadeOut state properties as well to provide the fade properties that are different for the two phases - in this case, the duration fade property values.

3.10.1. Common Duration

If the duration of the fade-in is to be the same as the duration of the fade-out, then this common duration can be specified in the fadeInOut property, rather than redundantly in both the fadeIn and fadeOut properties.

3.10.2. Special Handling of reverse Fade Property

The reverse fade property has special handling in the context of this widget class.

Normally, when specifying the value true for the reverse fade property, the entire fade will be reversed. However, the Uize.Widget.HoverFader class guarantees that at the end of the fade-in phase the style settings for a node will be those specified by the hoverStyle state property. Similarly, at the end of the fade-out phase the style settings for a node will be those specified by the defaultStyle state property.

Therefore, when specifying the value true for the reverse fade property, the Uize.Widget.HoverFader class swaps the values that it would normally use as the start and end values of the style fade for a node. This has the effect of only reversing the transition effect, but not the start and end style. This becomes more pronounced - and more compelling - when compound values are specified for the curve fade property, where reversing the effect of the curves produces interesting results.

Now, when specifying a value for the fadeInOut state property, the value of the reverse fade property for the fade-out is automatically defaulted to being the logical not of the value specified for this property in the fadeInOut object. This has the effect of making the fade-out a mirror of the fade-in - especially useful with settings that accomplish complex color transitions, where this behavior guarantees the same color transition effect for both phases of the effect. In order to override this automatic defaulting behavior, you can always explicitly specify values for the reverse fade property in either - or both - of the fadeIn and fadeOut objects.

NOTES

see the companion fadeIn and fadeOut state properties
the initial value is undefined

IMPLEMENTATION INFO

this feature was introduced in this module

3.11. fadeOut

An object, specifying fade properties for the fade-out phase (ie. when mousing out of a node) of the hover fade effect.

If the default fade-out duration does not suit your needs, you should at least use this property to configure a suitable duration. Any valid state properties of the Uize.Fade class (such as curve) can be specified in the fadeOut object, and these values will be applied when the fade-out starts.

EXAMPLE VALUE

{
  duration:1000,
  curve:Uize.Fade.celeration (.5,.5)
}

NOTES

see the companion fadeIn and fadeInOut state properties
the initial value is {duration:350}

IMPLEMENTATION INFO

this feature was introduced in this module

3.12. hoverStyle

An object, whose properties specify the values for CSS style properties at the end of the hover fade-in (and also the start of the hover fade-out).

EXAMPLE VALUE

{
  width:'100px',
  borderLeftWidth:'11px',
  color:'fff',           // white
  backgroundColor:'77a', // pastel blue
  borderColor:'000'      // black
}

The hoverStyle object may contain values for any of the supported CSS style properties (see the section Fading CSS Style Properties). The structure of the object should match the structure of the companion defaultStyle state property's value, or the effect will not work correctly. In other words, if the hoverStyle object contains a value for borderColor, then the defaultStyle object must also contain a value for this style property.

For a more complete example of how this state property is used in conjunction with other state properties, consult the section An Example.

NOTES

for best effect, style property values specified in this property should match the hover style property values for the nodes (as determined by stylesheet rules for your page)
see the companion defaultStyle state property
the initial value is {color:'000',backgroundColor:'fff'}

IMPLEMENTATION INFO

this feature was introduced in this module

3.13. html

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.14. idPrefix

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.15. idPrefixConstruction

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.16. insertionMode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.17. localized

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.18. name

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.19. nodeMap

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

3.20. nodes

An array or collection of nodes or a find expression object, specifying the nodes that should be wired up with the hover fade effect.

The value of this property can be...

a string, being the id of a single node to wire up
a node reference to a single node to wire up
an array of nodes to wire up, where each element can be a string, or node reference
an object, being a find expression (see the Uize.Dom.Basics.find static method)

EXAMPLE 1

var hoverFader = Uize.Widget.HoverFader ({
  nodes:['link1Id','link2Id','link3Id']
});

EXAMPLE 2

var hoverFader = Uize.Widget.HoverFader ({
  nodes:document.getElementsByTagName ('A')
});

EXAMPLE 3

var hoverFader = Uize.Widget.HoverFader ({
  nodes:{tagName:'A',className:'hoverFadeLink'}
});

Each instance of the Uize.Widget.HoverFader class manages a set of nodes. For more information on the types of nodes that can be wired up and how they can be obtained, consult the section Any Nodes.

NOTES

the initial value is undefined

IMPLEMENTATION INFO

this feature was introduced in this module

3.21. wired

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4. Instance Properties

4.1. showConfirm

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.2. showInform

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5. Static Methods

5.1. Uize.Widget.HoverFader.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.2. Uize.Widget.HoverFader.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.3. Uize.Widget.HoverFader.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.4. Uize.Widget.HoverFader.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.5. Uize.Widget.HoverFader.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.6. Uize.Widget.HoverFader.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.7. Uize.Widget.HoverFader.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.8. Uize.Widget.HoverFader.getBlankImageUrl

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

5.9. Uize.Widget.HoverFader.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.10. Uize.Widget.HoverFader.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.11. Uize.Widget.HoverFader.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.12. Uize.Widget.HoverFader.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.13. Uize.Widget.HoverFader.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.14. Uize.Widget.HoverFader.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.15. Uize.Widget.HoverFader.spawn

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

5.16. Uize.Widget.HoverFader.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.17. Uize.Widget.HoverFader.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.18. Uize.Widget.HoverFader.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.19. Uize.Widget.HoverFader.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.20. Uize.Widget.HoverFader.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.21. Uize.Widget.HoverFader.treeInheritedStateProperties

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

5.22. Uize.Widget.HoverFader.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.23. Uize.Widget.HoverFader.valueOf

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

5.24. Uize.Widget.HoverFader.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses

6. Static Properties

6.1. Uize.Widget.HoverFader.busyInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

6.2. Uize.Widget.HoverFader.enabledInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

6.3. Uize.Widget.HoverFader.isWired

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)
this static feature is inherited by subclasses

6.4. Uize.Widget.HoverFader.moduleName

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is inherited by subclasses

6.5. Uize.Widget.HoverFader.nonInheritableStatics

IMPLEMENTATION INFO

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)
this static feature is not inherited by subclasses

6.6. Uize.Widget.HoverFader.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)
this static feature is inherited by subclasses