WinJS.UI.Animation.swipeSelect function

Performs a selection animation in response to a swipe interaction.

The following video demonstrates the swipe select and deselect animations:

Syntax

WinJS.UI.Animation.swipeSelect(selected, selection).done( /* Your success and error handlers */ );

Parameters

• selected
  Type: Object

  Element or elements being selected.

• selection
  Type: Object

  Element or elements that show that something is selected, typically a check mark.

Return value

Type: Promise**

An object that completes when the animation is finished.

Remarks

The parameters of this function 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

Requirements

Minimum WinJS version	WinJS 1.0
Namespace	WinJS.UI.Animation

See also

swipeDeselect

swipeReveal

Animating swipe gestures

Guidelines and checklist for swipe animations

HTML animation library sample