WinJS.UI.Animation.hidePopup function

Performs an animation that removes pop-up user interface (UI).

The following video demonstrates the show and hide pop-up animations:

Syntax

WinJS.UI.Animation.hidePopup(element).done( /* Your success and error handlers */ );

Parameters

• element
  Type: Object

  Element or elements that are being hidden.

Return value

Type: Promise**

An object that completes when the animation is finished.

Remarks

See the HTML animation library sample on the Windows Dev Center for a usage example of this function.

The element parameter 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

See also

showPopup

hidePanel

hideEdgeUI

Animating pop-up UI

Guidelines and checklist for pop-up UI animations

HTML animation library sample