UNPKG

2.29 kBTypeScriptView Raw
1export interface NativeTransitionOptions {
2 direction?: string;
3 duration?: number;
4 slowdownfactor?: number;
5 slidePixels?: number;
6 iosdelay?: number;
7 androiddelay?: number;
8 winphonedelay?: number;
9 fixedPixelsTop?: number;
10 fixedPixelsBottom?: number;
11 action?: string;
12 origin?: string;
13 href?: string;
14}
15/**
16 * @name NativePageTransitions
17 * @description
18 * The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction.
19 *
20 * @usage
21 * ```
22 * import {NativePageTransitions, NativeTransitionOptions} from 'ionic-native';
23 *
24 * let options: NativeTransitionOptions = {
25 * direction: 'up',
26 * duration: 500,
27 * slowdownfactor: 3,
28 * slidePixels: 20,
29 * iosdelay: 100,
30 * androiddelay: 150,
31 * winphonedelay: 250,
32 * fixedPixelsTop: 0,
33 * fixedPixelsBottom: 60
34 * };
35 *
36 * NativePageTransitions.slide(options)
37 * .then(onSuccess)
38 * .catch(onError);
39 *
40 * ```
41 */
42export declare class NativePageTransitions {
43 /**
44 * Perform a slide animation
45 * @param options {NativeTransitionOptions} Options for the transition
46 * @returns {Promise<any>}
47 */
48 static slide(options: NativeTransitionOptions): Promise<any>;
49 /**
50 * Perform a flip animation
51 * @param options {NativeTransitionOptions} Options for the transition
52 * @returns {Promise<any>}
53 */
54 static flip(options: NativeTransitionOptions): Promise<any>;
55 /**
56 * Perform a fade animation
57 * @param options {NativeTransitionOptions} Options for the transition
58 * @returns {Promise<any>}
59 */
60 static fade(options: NativeTransitionOptions): Promise<any>;
61 /**
62 * Perform a slide animation
63 * @param options {NativeTransitionOptions} Options for the transition
64 * @returns {Promise<any>}
65 */
66 static drawer(options: NativeTransitionOptions): Promise<any>;
67 /**
68 * Perform a slide animation
69 * @param options {NativeTransitionOptions} Options for the transition
70 * @returns {Promise<any>}
71 */
72 static curl(options: NativeTransitionOptions): Promise<any>;
73}