WinJS.UI.Animation.fadeOut function

Performs an animation that fades an item or set of items out of view.

The following video demonstrates the fade in and out animations:

Syntax

WinJS.UI.Animation.fadeOut(hidden).done( /* Your success and error handlers */ );

Parameters

  • hidden
    Type: Object

    Element or elements being faded out.

Return value

Type: Promise**

An object that completes when the animation is finished.

Remarks

The hidden parameter of this method can be expressed in several ways:

  • As the special value "undefined", which means that the animation has no such target
  • As a single object
  • As a JavaScript array (possibly empty), in which each element of the array can be a single element or a JavaScript array of elements.
  • As a NodeList (for example, the result of querySelectorAll)
  • As an HTMLCollection

If you want to remove an element involved in this animation from the document altogether, doing so before the animation is complete causes the animation to abruptly stop. You should use the Promise to be notified when the animation completes and then remove the element from the document.

Requirements

Minimum WinJS version

WinJS 1.0

Namespace

WinJS.UI.Animation

See also

fadeIn

Animating fades

Guidelines and checklist for fade animations

HTML animation library sample