packages/typescript-typings/types/react-joyride/index.d.ts


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

// Type definitions for react-joyride 2.0.0-11
// Project: https://github.com/gilbarbara/react-joyride

declare module 'react-joyride' {
    import * as React from 'react';
    export interface StyleOptions {
        arrowColor?: string;
        backgroundColor?: string;
        primaryColor?: string;
        textColor?: string;
        overlayColor?: string;
        spotlightShadow?: string;
        beaconSize?: number;
        zIndex?: number;
    }

    export type Placement =
        | 'top'
        | 'top-left'
        | 'top-right'
        | 'bottom'
        | 'bottom-left'
        | 'bottom-right'
        | 'right'
        | 'left';

    export interface Step {
        title?: string;
        content: React.ReactNode;
        target: string;
        placement?: Placement;
        type?: 'click' | 'hover';
        isFixed?: boolean;
        allowClicksThruHole?: boolean;
        disableBeacon?: boolean;
        style?: StyleOptions;
        [prop: string]: any;
    }

    interface StyleOptionsProp {
        options: StyleOptions;
    }

    export interface Props {
        steps?: Step[];
        beaconComponent?: React.ReactNode;
        disableOverlayClose?: boolean;
        run?: boolean;
        stepIndex?: number;
        callback?: (options: any) => void;
        debug?: boolean;
        styles?: StyleOptionsProp;
    }

    export interface State {
        action: string;
        controlled: boolean;
        index: number;
        lifecycle: string;
        size: 0;
        status: string;
    }

    export default class Joyride extends React.Component<Props, State> {
        constructor(props: Props);

        static defaultProps: Props;
    }
}