Skip to content

Commit a64f67e

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

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,22 @@ var enjoyhint_script_steps = [
7979
* `bottom` - bottom margin for the shape of "rect" type
8080
* `left` - left margin for the shape of "rect" type
8181
* `scrollAnimationSpeed` - sets the auto scroll speed (ms).
82+
* `nextButton` - allows applying its classes and names for the button Nеxt.
83+
* `skipButton` - allows applying its classes and names for the button Skip. For the example :
84+
```javascript
85+
var options = {
86+
"next #block": 'Hello.',
87+
"nextButton" : {className: "myNext", text: "NEXT"},
88+
"skipButton" : {className: "mySkip", text: "SKIP"},
89+
90+
}
91+
```
8292
* `showSkip` - shows or hides the Skip button (true|false)
8393
* `showNext` - shows or hides the Next button (true|false)
8494

8595

8696

97+
8798
#### Non-standard events:
8899
**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.
89100
* `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.
@@ -130,4 +141,20 @@ var enjoyhint_script_steps = [
130141
];
131142
```
132143

144+
#### Release notes
145+
146+
##### v.3
147+
148+
* New and simplified description of EnjoyHint steps
149+
* Auto scroll to the element
150+
* Possibility to hide or display the buttons showNext, showSkip.
151+
* HTML usage allowed in description
152+
* Destructor
153+
* Simplified property names
154+
* Grunt to compress and merge files
155+
* New examples
156+
* You can learn the step you are on by the class enjoyhint-step-* ( where * stands for the step number).
157+
158+
159+
133160

0 commit comments

Comments
 (0)