Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes and additions #172

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ var enjoyhint_script_steps = [
* `arrowColor` - the color of a marker that accepts all CSS colors.
* `keyCode` - the code of a button, which triggers the next EnjoyHint step upon a click. Defined by the “key” event. (“key #block” : “hello”).
* `event_selector` - if you need to attach an event (that was set in "event" property) to other selector, you can use this one
* `disableSelector` - disables any interaction with the element. The user is forced to use the "Next" or the "Skip" buttons.
* `timeout` - delay before the moment, when an element is highlighted
* `shape` - shape for highlighting (circle|rect)
* `radius` - if the shape of "circle" is specified, we can set the radius.
Expand All @@ -98,13 +99,15 @@ var enjoyhint_script_steps = [
* `scrollAnimationSpeed` - sets the auto scroll speed (ms).
* `nextButton` - allows applying its classes and names for the button Nеxt.
* `skipButton` - allows applying its classes and names for the button Skip.
* `prevButton` - allows applying its classes and names for the button Previous. For the example :
* `prevButton` - allows applying its classes and names for the button Previous.
* `closeButton` - allows applying its classes for the button Close (×). For the example :
```javascript
var options = {
"next #block": 'Hello.',
"nextButton" : {className: "myNext", text: "myNEXT"},
"skipButton" : {className: "mySkip", text: "mySKIP"},
"prevButton" : {className: "myPrev", text: "myPREV"}
"prevButton" : {className: "myPrev", text: "myPREV"},
"closeButton" : {className: "myClose"},
}
```
* `showSkip` - shows or hides the Skip button (true|false)
Expand Down Expand Up @@ -133,12 +136,14 @@ $.get('/load/some_data', function(data){
* `run` - run the current script. Has no arguments
* `resume` - resume the script from the step where it was stopped. Has no arguments
* `getCurrentStep` - returns the current step index
* `trigger` - After writing this code you can either move to the next step or finish with EnjoyHint (next|skip)
* `trigger` - after writing this code you can either move to the next step or finish with EnjoyHint (next|skip)
* `skip` - hide the current script. Has no arguments
* `destroy` - destroy the enjoyHint. Has no arguments

#### Events
**Script Events**:
* `onStart` - fires on the first step.
* `onEnd` - fires after the last step in script.
* `onEnd` - fires after the last step in script and click close button.
* `onSkip` - fires after user has clicked skip.
```javascript
var enjoyhint_instance = new EnjoyHint({
Expand Down Expand Up @@ -166,9 +171,13 @@ var enjoyhint_script_steps = [

##### v.4

* Fixed bugs with "Next" button
* Fixed label position bugs
* Fixed arrow position bugs
* Fixed resize bugs
* Added possibility to disable selector
* Added possibility to customize close button
* Added method to destroy hint instance
* Added responsive design
* Added mobile support
* Added possibility to go back to previous step
Expand Down
2 changes: 1 addition & 1 deletion enjoyhint.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading