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
+11-19Lines changed: 11 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,9 @@ EnjoyHint
4
4
5
5
EnjoyHint is free software distributed under the terms of MIT license.
6
6
7
-
Check out this [issue tracker demo with EnjoyHint](http://xbsoftware.com/products/enjoyhint/) and a [TODO app demo](http://xbsoftware.github.io/enjoyhint/) ([downloadable package](http://xbsoftware.github.io/enjoyhint/enjoyhint_todo_demo.zip))
@@ -58,32 +58,24 @@ Highlight some button and after you click on it, highlight some panel:
58
58
```javascript
59
59
var enjoyhint_script_steps = [
60
60
{
61
-
selector:'.some_btn',//jquery selector
62
-
event:'click',
63
-
description:'Click on this btn'
61
+
"click .some_btn":'Click on this btn'
64
62
},
65
63
{
66
-
selector:'.some_panel',//jquery selector
67
-
event:'click',
68
-
description:'Click on this panel'
64
+
"click .some_panel":'Click on this panel'
69
65
}
70
66
];
71
67
```
72
68
73
69
#### Properties of the step configuration
74
-
*`selector` - jquery selector of the DOM-element, that will be highlighted
75
-
*`event` - a jquery event that is set for the element defined in the selector. When it fires, the next step is triggered.
76
70
*`key_code` - key code for any "key*" event. Event fires only if key code of the pressed key is equal to this property.
77
71
*`event_selector` - if you need to attach an event (that was set in "event" property) to other selector, you can use this one
78
-
*`description` - description for the highlighted element
79
72
*`timeout` - delay before the moment, when an element is highlighted
80
73
*`shape` - shape for highlighting (circle|rect)
81
74
*`margin` - margin for the highlight shape (for Ex.:10)
82
75
*`top` - top margin for the shape of "rect" type
83
76
*`right` - right margin for the shape of "rect" type
84
77
*`bottom` - bottom margin for the shape of "rect" type
85
78
*`left` - left margin for the shape of "rect" type
86
-
*`event_type` - type of event that will get you to the next step(auto|custom|next)
87
79
88
80
#### Event Types descriptions:
89
81
**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.
0 commit comments