Skip to content

Commit 295f937

Browse files
committed
Add v0.5.0 release note + update documentation
1 parent 1f8b2d0 commit 295f937

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For example:
1616
<a href='http://google.com/' data-intro='Hello step one!' data-step='1'></a>
1717
````
1818

19-
Optionally you can define `data-position` attribute to define the position of tooltip with values `top`, `right`, `left` and `bottom`. Default value is `bottom`.
19+
See all attributes [here](https://github.com/usablica/intro.js/#attributes).
2020

2121
**3)** Call this JavaScript function:
2222
```javascript
@@ -145,6 +145,23 @@ introJs().setOptions({ skipLabel: "Exit", tooltipPosition: "right" });
145145

146146
----
147147

148+
###introJs.refresh()
149+
150+
To refresh and order layers manually
151+
152+
**Available since**: v0.5.0
153+
154+
**Returns:**
155+
- introJs object.
156+
157+
**Example:**
158+
```javascript
159+
introJs().refresh();
160+
````
161+
162+
----
163+
164+
148165
###introJs.oncomplete(providedCallback)
149166

150167
Set callback for when introduction completed.
@@ -230,6 +247,12 @@ introJs().onbeforechange(function(targetElement) {
230247

231248
-----
232249

250+
###Attributes:
251+
- `data-intro`: The tooltip text of step
252+
- `data-step`: The number of step
253+
- `data-tooltipClass`: Optionally define a CSS class for tooltip
254+
- `data-position`: Optionally define the position of tooltip, `top`, `left`, `right` or `bottom`. Default is `bottom`
255+
233256
###Options:
234257

235258
- `steps`: For defining steps using JSON configuration (see [this](https://github.com/usablica/intro.js/blob/master/example/programmatic/index.html) example)
@@ -238,11 +261,12 @@ introJs().onbeforechange(function(targetElement) {
238261
- `skipLabel`: Skip button label
239262
- `doneLabel`: Done button label
240263
- `tooltipPosition`: Default tooltip position
264+
- `tooltipClass`: Adding CSS class to all tooltips
241265
- `exitOnEsc`: Exit introduction when pressing Escape button, `true` or `false`
242266
- `exitOnOverlayClick`: Exit introduction when clicking on overlay layer, `true` or `false`
243267
- `showStepNumbers`: Show steps number in the red circle or not, `true` of `false`
244268

245-
See [setOption](https://github.com/usablica/intro.js/edit/master/README.md#introjssetoptionoption-value) to see an example.
269+
See [setOption](https://github.com/usablica/intro.js/#introjssetoptionoption-value) to see an example.
246270

247271
## Using with:
248272

@@ -264,10 +288,22 @@ Now you can run this command to minify all static resources:
264288

265289
## Roadmap
266290
- More browser compatibility
291+
- Fix problems with `position: fixed` and other positions
267292
- Provide more examples
268293

269294
## Release History
270295

296+
* **v0.5.0** - 2013-07-19
297+
- Add CSS class option for tooltips (And tooltip buttons also)
298+
- Add RTL version
299+
- Ability to add HTML codes in tooltip content
300+
- Ability to add DOM object and CSS selector in programmatic API (So you can use jQuery selector engine)
301+
- Add `refresh()` method to refresh and order layers manually
302+
- Show tooltip buttons only when introduction steps are more than one
303+
- Fix `onbeforechange` event bug and pass correct object in parameters
304+
- Fix `Null element exception` in some browsers
305+
- And add more examples
306+
271307
* **v0.4.0** - 2013-05-20
272308
- Add multi-page introduction example
273309
- Add programmatic introduction definition

0 commit comments

Comments
 (0)