Skip to content

Commit e5dda90

Browse files
committed
Add v0.3.0 help + release note
1 parent ceb103f commit e5dda90

File tree

1 file changed

+125
-2
lines changed

1 file changed

+125
-2
lines changed

README.md

Lines changed: 125 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@
66
## How to use
77
Intro.js can be added to your site in three simple steps:
88

9-
**1)** Include `intro.js` and `introjs.css` (or the minified version for production) in your page.
9+
**1)** Include `intro.js` and `introjs.css` (or the minified version for production) in your page.
10+
11+
> Note: if you need Internet Explorer compatiblity, you have to add introjs-ie.css to the page also:
12+
13+
```html
14+
<!--[if lte IE 8]>
15+
<link href="../introjs-ie.css" rel="stylesheet">
16+
<!-- <![endif]-->
17+
````
1018

1119
**2)** Add `data-intro` and `data-step` to your HTML elements.
1220

@@ -49,7 +57,9 @@ Creating an introJs object.
4957
introJs() //without selector, start introduction for whole page
5058
introJs("#intro-farm") //start introduction for element id='intro-farm'
5159
````
52-
60+
61+
-----
62+
5363
###introJs.start()
5464

5565
Start the introduction for defined element(s).
@@ -63,6 +73,85 @@ Start the introduction for defined element(s).
6373
```javascript
6474
introJs().start()
6575
````
76+
-----
77+
78+
###introJs.goToStep(step)
79+
80+
Go to specific step of introduction.
81+
82+
**Available since**: v0.3.0
83+
84+
**Parameters:**
85+
- step : Number
86+
87+
**Returns:**
88+
- introJs object.
89+
90+
**Example:**
91+
```javascript
92+
introJs().goToStep(2).start(); //starts introduction from step 2
93+
````
94+
95+
-----
96+
97+
###introJs.exit()
98+
99+
Exit the introduction.
100+
101+
**Available since**: v0.3.0
102+
103+
**Returns:**
104+
- introJs object.
105+
106+
**Example:**
107+
```javascript
108+
introJs().exit()
109+
````
110+
111+
-----
112+
113+
###introJs.setOption(option, value)
114+
115+
Set a single option to introJs object.
116+
117+
**Available since**: v0.3.0
118+
119+
**Parameters:**
120+
- option : String
121+
Option key name.
122+
123+
- value : String/Number
124+
Value of the option.
125+
126+
**Returns:**
127+
- introJs object.
128+
129+
**Example:**
130+
```javascript
131+
introJs().setOption("skipLabel", "Exit");
132+
````
133+
134+
----
135+
136+
###introJs.setOptions(options)
137+
138+
Set a group of options to the introJs object.
139+
140+
**Available since**: v0.3.0
141+
142+
**Parameters:**
143+
- options : Object
144+
Object that contains option keys with values.
145+
146+
**Returns:**
147+
- introJs object.
148+
149+
**Example:**
150+
```javascript
151+
introJs().setOptions({ skipLabel: "Exit", tooltipPosition: "right" });
152+
````
153+
154+
----
66155

67156
###introJs.oncomplete(providedCallback)
68157

@@ -83,6 +172,8 @@ introJs().oncomplete(function() {
83172
});
84173
````
85174

175+
-----
176+
86177
###introJs.onexit(providedCallback)
87178

88179
Set callback to exit of introduction. Exit also means pressing `ESC` key and clicking on the overlay layer by the user.
@@ -102,6 +193,27 @@ introJs().onexit(function() {
102193
});
103194
````
104195

196+
-----
197+
198+
###introJs.onchange(providedCallback)
199+
200+
Set callback to change of each step of introduction. Given callback function will be called after completing each step.
201+
202+
**Available since:** v0.3.0
203+
204+
**Parameters:**
205+
- providedCallback : Function
206+
207+
**Returns:**
208+
- introJs object.
209+
210+
**Example:**
211+
```javascript
212+
introJs().onchange(function() {
213+
alert("new step");
214+
});
215+
````
216+
105217
## Using with:
106218

107219
### Rails
@@ -121,10 +233,21 @@ Now you can run this command to minify all static resources:
121233

122234

123235
## Roadmap
236+
- Multi-page introduction
124237
- More browser compatibility
125238

126239

127240
## Release History
241+
* **v0.3.0** - 2013-03-28
242+
- Adding support for CommonJS, RequireJS AMD and Browser Globals.
243+
- Add `goToStep` function to go to specific step of introduction.
244+
- Add `onchange` callback.
245+
- Add `exit` function to exit from introduction.
246+
- Adding options with `setOption` and `setOptions` functions.
247+
- More IE compatibility.
248+
- Fix `min-width` bug with tooltip box.
249+
- Code cleanup + Better coding style.
250+
128251
* **v0.2.1** - 2013-03-20
129252
- Fix keydown event unbinding bug.
130253

0 commit comments

Comments
 (0)