Skip to content

Commit 8edb801

Browse files
committed
Update README.md
1 parent 1d35c91 commit 8edb801

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,24 @@ var enjoyhint_script_steps = [
6767
```
6868

6969
#### 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”).
7172
* `event_selector` - if you need to attach an event (that was set in "event" property) to other selector, you can use this one
7273
* `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.
7476
* `margin` - margin for the highlight shape (for Ex.:10)
7577
* `top` - top margin for the shape of "rect" type
7678
* `right` - right margin for the shape of "rect" type
7779
* `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)
7984

80-
#### Event Types descriptions:
85+
86+
87+
#### Non-standard events:
8188
**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.
8289
* `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.
8390
```javascript
@@ -88,6 +95,8 @@ $.get('/load/some_data', function(data){
8895
});
8996
```
9097
* `next` - when you set value of event_type to "next", you will see the "Next" btn on this step.
98+
* `key` - tells EnjoyHint to go to the next step when you click on the button defined by the keyCode
99+
91100

92101
#### Methods
93102
* `set` - set current steps configuration. Arguments: config
@@ -120,3 +129,5 @@ var enjoyhint_script_steps = [
120129
}
121130
];
122131
```
132+
133+

0 commit comments

Comments
 (0)