Skip to content

README.md - Fix ### headings #1

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md - Fix ### headings #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ In order to use templates, all you need to do is appending the template styleshe

## API

###introJs([targetElm])
### introJs([targetElm])

Creating an introJs object.

Expand All @@ -79,7 +79,7 @@ introJs("#intro-farm") //start introduction for element id='intro-farm'

-----

###introJs.start()
### introJs.start()

Start the introduction for defined element(s).

Expand All @@ -94,7 +94,7 @@ introJs().start()
````
-----

###introJs.goToStep(step)
### introJs.goToStep(step)

Go to specific step of introduction.

Expand All @@ -113,7 +113,7 @@ introJs().goToStep(2).start(); //starts introduction from step 2

-----

###introJs.nextStep()
### introJs.nextStep()

Go to next step of introduction.

Expand All @@ -129,7 +129,7 @@ introJs().start().nextStep();

-----

###introJs.previousStep()
### introJs.previousStep()

Go to previous step of introduction.

Expand All @@ -145,7 +145,7 @@ introJs().goToStep(3).start().previousStep(); //starts introduction from step 2

-----

###introJs.exit()
### introJs.exit()

Exit the introduction.

Expand All @@ -161,7 +161,7 @@ introJs().exit()

-----

###introJs.setOption(option, value)
### introJs.setOption(option, value)

Set a single option to introJs object.

Expand All @@ -184,7 +184,7 @@ introJs().setOption("skipLabel", "Exit");

----

###introJs.setOptions(options)
### introJs.setOptions(options)

Set a group of options to the introJs object.

Expand All @@ -204,7 +204,7 @@ introJs().setOptions({ 'skipLabel': 'Exit', 'tooltipPosition': 'right' });

----

###introJs.refresh()
### introJs.refresh()

To refresh and order layers manually

Expand All @@ -221,7 +221,7 @@ introJs().refresh();
----


###introJs.oncomplete(providedCallback)
### introJs.oncomplete(providedCallback)

Set callback for when introduction completed.

Expand All @@ -242,7 +242,7 @@ introJs().oncomplete(function() {

-----

###introJs.onexit(providedCallback)
### introJs.onexit(providedCallback)

Set callback to exit of introduction. Exit also means pressing `ESC` key and clicking on the overlay layer by the user.

Expand All @@ -263,7 +263,7 @@ introJs().onexit(function() {

-----

###introJs.onchange(providedCallback)
### introJs.onchange(providedCallback)

Set callback to change of each step of introduction. Given callback function will be called after completing each step.
The callback function receives the element of the new step as an argument.
Expand All @@ -285,7 +285,7 @@ introJs().onchange(function(targetElement) {

-----

###introJs.onbeforechange(providedCallback)
### introJs.onbeforechange(providedCallback)

Given callback function will be called before starting a new step of introduction. The callback function receives the element of the new step as an argument.

Expand All @@ -306,7 +306,7 @@ introJs().onbeforechange(function(targetElement) {

-----

###introJs.onafterchange(providedCallback)
### introJs.onafterchange(providedCallback)

Given callback function will be called after starting a new step of introduction. The callback function receives the element of the new step as an argument.

Expand All @@ -326,13 +326,13 @@ introJs().onafterchange(function(targetElement) {
````

-----
###Attributes:
### Attributes:
- `data-intro`: The tooltip text of step
- `data-step`: Optionally define the number (priority) of step
- `data-tooltipClass`: Optionally define a CSS class for tooltip
- `data-position`: Optionally define the position of tooltip, `top`, `left`, `right`, `bottom`, `bottom-left-aligned` (same as 'bottom'), 'bottom-middle-aligned' and 'bottom-right-aligned'. Default is `bottom`

###Options:
### Options:

- `steps`: For defining steps using JSON configuration (see [this](https://github.com/usablica/intro.js/blob/master/example/programmatic/index.html) example)
- `nextLabel`: Next button label
Expand Down