Skip to content

Commit 53268fb

Browse files
committed
Add v0.4.0 release note + update documentation
1 parent ed5ea6b commit 53268fb

File tree

1 file changed

+54
-10
lines changed

1 file changed

+54
-10
lines changed

README.md

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,6 @@ Intro.js can be added to your site in three simple steps:
88

99
**1)** Include `intro.js` and `introjs.css` (or the minified version for production) in your page.
1010

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-
````
18-
1911
**2)** Add `data-intro` and `data-step` to your HTML elements.
2012

2113
For example:
@@ -215,6 +207,43 @@ introJs().onchange(function(targetElement) {
215207
});
216208
````
217209

210+
-----
211+
212+
###introJs.onbeforechange(providedCallback)
213+
214+
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.
215+
216+
**Available since:** v0.4.0
217+
218+
**Parameters:**
219+
- providedCallback : Function
220+
221+
**Returns:**
222+
- introJs object.
223+
224+
**Example:**
225+
```javascript
226+
introJs().onbeforechange(function(targetElement) {
227+
alert("before new step");
228+
});
229+
````
230+
231+
-----
232+
233+
###Options:
234+
235+
- `steps`: For defining steps using JSON configuration (see [this](https://github.com/usablica/intro.js/blob/master/example/programmatic/index.html) example)
236+
- `nextLabel`: Next button label
237+
- `prevLabel`: Previous button label
238+
- `skipLabel`: Skip button label
239+
- `doneLabel`: Done button label
240+
- `tooltipPosition`: Default tooltip position
241+
- `exitOnEsc`: Exit introduction when pressing Escape button, `true` or `false`
242+
- `exitOnOverlayClick`: Exit introduction when clicking on overlay layer, `true` or `false`
243+
- `showStepNumbers`: Show steps number in the red circle or not, `true` of `false`
244+
245+
See [setOption](https://github.com/usablica/intro.js/edit/master/README.md#introjssetoptionoption-value) to see an example.
246+
218247
## Using with:
219248

220249
### Rails
@@ -234,11 +263,26 @@ Now you can run this command to minify all static resources:
234263

235264

236265
## Roadmap
237-
- Multi-page introduction
238266
- More browser compatibility
239-
267+
- Provide more examples
240268

241269
## Release History
270+
271+
* **v0.4.0** - 2013-05-20
272+
- Add multi-page introduction example
273+
- Add programmatic introduction definition
274+
- Cooler introduction background!
275+
- Remove IE specific css file and embed IE support to main css file (property fallback)
276+
- Update introduction position on window resize (Also support tablet/mobile devices rotation)
277+
- Disable buttons on the first and start of introduction (Skip and Done button)
278+
- Add `onbeforechange` callback
279+
- Add `showStepNumbers` option to show/hide step numbers
280+
- Add `exitOnEsc` and `exitOnOverlayClick` options
281+
- Fix bad tooltip position calculating problem
282+
- Fix a bug when using `!important` in element css properties
283+
- Fix a bug in `onexit` behavior
284+
- Code refactoring
285+
242286
* **v0.3.0** - 2013-03-28
243287
- Adding support for CommonJS, RequireJS AMD and Browser Globals.
244288
- Add `goToStep` function to go to specific step of introduction.

0 commit comments

Comments
 (0)