FilesExpand file tree

main

/

index.d.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

132 lines (126 loc) · 2.96 KB

main

/

index.d.ts

Copy path

Top

File metadata and controls

• Code
• Blame

132 lines (126 loc) · 2.96 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

import * as React from 'react';

import { IntroJs, Options } from 'intro.js';

interface Step {

/**

* CSS selector or element to use for the step.

*/

element?: string | HTMLElement | Element;

/**

* The tooltip content.

*/

intro: string | React.ReactNode;

/**

* Position of the tooltip.

*/

position?: string;

/**

* The tooltip title.

*/

title?: string;

/**

* CSS class of the tooltip.

*/

tooltipClass?: string;

/**

* CSS class of the helperLayer.

*/

highlightClass?: string;

}

interface Hint {

/**

* CSS selector to use for the hint.

*/

element: string;

/**

* The tooltip text.

*/

hint: string;

/**

* Position of the tooltip.

*/

hintPosition?: string;

}

interface StepsProps {

/**

* Defines if the steps are visible or not.

* @default false

*/

enabled?: boolean;

/**

* Step index to start with when showing the steps.

*/

initialStep: number;

/**

* All the steps.

*/

steps: Step[];

/**

* Callback called when the steps are disabled.

* Required to force keeping track of the state when the steps are dismissed with an Intro.js event and not the

* enabled prop.

*/

onExit(stepIndex: number): void;

/**

* Callback called before exiting the intro.

* If you want to prevent exiting the intro, you can return false in this callback (available since intro.js 0.2.7).

*/

onBeforeExit?(stepIndex: number): void | false;

/**

* Callback called when the steps are enabled.

*/

onStart?(stepIndex: number): void;

/**

* Callback called when the current step is changed.

*/

onChange?(nextStepIndex: number, nextElement: Element): void;

/**

* Callback called before changing the current step.

* If you want to prevent the transition to the next / previous step, you can return false in this callback

* (available since intro.js 2.8.0).

*/

onBeforeChange?(nextStepIndex: number, nextElement: Element): void | false | Promise<void | false>;

/**

* Callback called after changing the current step.

*/

onAfterChange?(newStepIndex: number, newElement: Element): void;

/**

* Callback called if you prevented transitioning to a new step by returning false in onBeforeChange.

*/

onPreventChange?(stepIndex: number): void;

/**

* Callback called when all the steps are completed.

*/

onComplete?(): void;

/**

* Intro.js options.

*/

options?: Options;

}

interface HintsProps {

/**

* Defines if the hints are visible or not.

* @default false

*/

enabled?: boolean;

/**

* All the hints.

*/

hints: Hint[];

/**

* Callback called when a hint is clicked.

*/

onClick?(): void;

/**

* Callback called when a hint is closed.

*/

onClose?(): void;

/**

* Intro.js options.

*/

options?: Options;

}

export class Steps extends React.Component<StepsProps> {

public introJs: IntroJs;

public updateStepElement(stepIndex: number): void;

}

export class Hints extends React.Component<HintsProps> {}