Skip to content

Commit 34f051e

Browse files
committed
update README for v0.9.0
1 parent cb03dc8 commit 34f051e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,8 @@ scope of the uiTour directive, and can be required as `TourController` in direct
231231
| prev() | Hides the current step and shows the previous one. <br> **Parameters:** \<none\> <br> **Returns:** _Promise_ Resolves after previous step is shown. |
232232
| goTo() | Hides the current step and jumps to the provided one. <br> **Parameters:** _step_ Can be step object, step ID string, or step index <br> **Returns:** _Promise_ Resolved when provided step is shown, rejects if no step provided or found. |
233233
| getStatus() | Returns the current status of the tour based on TourStatus enum. <br> **Parameters:** \<none\> <br> **Returns:** TourStatus (ON, OFF, PAUSED, WAITING). Usage example: after tour starts: `tour.getStatus() === tour.Status.ON; //true` |
234-
| createStep() | Adds a step via a step configuration object. <br> **Parameters:** _step_ - a step config object: must contain an `element` (jQLite object) or `elementId` (string) attribute. `elementId` is resolved the first time a step is shown. |
234+
| createStep() | Adds a step via a step configuration object. <br> **Parameters:** _step_ - a step config object: must contain an `element` (jQLite object) or `selector` (string) attribute. `selector` is resolved the first time a step is shown. |
235+
| reposition() | Forces the active step popover and backdrop (if visible) to reposition around the step target. This is useful when the size of the target changes dynamically after the step is activated. |
235236

236237
### `createStep()` Example
237238

@@ -240,7 +241,7 @@ scope of the uiTour directive, and can be required as `TourController` in direct
240241
//somewhere that you have access to a `tour`:
241242

242243
tour.createStep({
243-
elementId: 'adHocStepTarget',
244+
selector: '#adHocStepTarget',
244245
stepId: 'optionalUniqueId',
245246
order: 15,
246247
title: 'Ad Hoc Step!',

0 commit comments

Comments
 (0)