react-native-wizard/react-native-wizard.d.ts at master · talut/react-native-wizard · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// Type definitions for react-native-wizard 2.1.1
// Project: https://github.com/talut/react-native-wizard
// Definitions by: Talut TASGIRAN <https://github.com/talut>
// TypeScript Version: 2.8

declare module "react-native-wizard" {
  import { RefObject, FunctionComponent } from "react"

  export interface WizardRef {
    /**
     * Go to next step
     */
    next: () => void,

    /**
     * Go to previous step
     */
    prev: () => void,

    /**
     * Go to step with index
     * @param index Step index
     */
    goTo: (index: number) => void,
  }

  interface WizardProps {
    /**
     Ref is required for using this package
     */
    ref: RefObject<WizardRef>,

    /**
     Set active step with index of step.
     */
    activeStep?: number,

    /**
     Set step with props.
     */
    steps: any,

    /**
     Set transition animation duration.
     */
    duration?: number,

    /**
     Callback function run after next()
     */
    onNext?: () => void,

    /**
     nextStepAnimation name
     */
    nextStepAnimation?: string,

    /**
     prevStepAnimation name
     */
    prevStepAnimation?: string,

    /**
     Callback function: running if is first step
     */
    isFirstStep?: (value: boolean) => void,

    /**
     Callback function: running if is last step
     */
    isLastStep?: (value: boolean) => void,

    /**
     useNativeDriver
     */
    useNativeDriver?: boolean,

    /**
     contentContainerStyle
     */
    contentContainerStyle?: object,

    /**
     Callback function run step change.
     */
    currentStep: (payload: {
      currentStep: number;
      isFirstStep: boolean;
      isLastStep: boolean
    }) => void;
  }

  const Wizard: FunctionComponent<WizardProps>
  export default Wizard
}