You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-4Lines changed: 15 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,17 +67,24 @@ var enjoyhint_script_steps = [
67
67
```
68
68
69
69
#### Properties of the step configuration
70
-
*`key_code` - key code for any "key*" event. Event fires only if key code of the pressed key is equal to this property.
70
+
*`"event selector" : "description"` - to describe a step you should set an event type, selecte element and add description for this element (hint)
71
+
*`keyCode` - the code of a button, which triggers the next EnjoyHint step upon a click. Defined by the “key” event. (“key #block” : “hello”).
71
72
*`event_selector` - if you need to attach an event (that was set in "event" property) to other selector, you can use this one
72
73
*`timeout` - delay before the moment, when an element is highlighted
73
-
*`shape` - shape for highlighting (circle|rect)
74
+
*`shape` - shape for highlighting (circle|rect)
75
+
*`radius` - if the shape of "circle" is specified, we can set the radius.
74
76
*`margin` - margin for the highlight shape (for Ex.:10)
75
77
*`top` - top margin for the shape of "rect" type
76
78
*`right` - right margin for the shape of "rect" type
77
79
*`bottom` - bottom margin for the shape of "rect" type
78
-
*`left` - left margin for the shape of "rect" type
80
+
*`left` - left margin for the shape of "rect" type
81
+
*`scrollAnimationSpeed` - sets the auto scroll speed (ms).
82
+
*`showSkip` - shows or hides the Skip button (true|false)
83
+
*`showNext` - shows or hides the Next button (true|false)
79
84
80
-
#### Event Types descriptions:
85
+
86
+
87
+
#### Non-standard events:
81
88
**auto** - for example, you need to click on the same button on the second step imediatelly after the first step and go to the next step after it. Then you can use "auto" in the "event_type" property and "click" in "event" property.
82
89
*`custom` - this value is very usefull if you need to go to the next step by event in your app code. For example, you want to go to the next step only after some data have been loaded in your application. Then you should use the "custom" event_type and the "trigger" method of the EnjoyHint instance.
0 commit comments