Share via


FlipView.setCustomAnimations method

Sets custom animations for the FlipView to use when navigating between pages. These custom animations only apply to keyboard, mouse, and programmatically triggered navigation actions.

Syntax

flipView.setCustomAnimations(animations);

Parameters

  • animations
    Type: Object

    An object that contains up to three fields, one for each navigation action: next, previous, and jump.

    Each of those fields must be a function with this signature: function (outgoingPage, incomingPage) Each function must return a WinJS.Promise that completes once the animations are finished.

    If a field is null or undefined, the FlipView reverts to its default animation for that action.

Return value

This method does not return a value.

Requirements

Minimum WinJS version

WinJS 3.0

Namespace

WinJS.UI

See also

FlipView