chore(docs): document clearMovePrevented method

josias-r · Mar 20, 2023 · df21ab8 · df21ab8
1 parent 5bba583
commit df21ab8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/index.html b/index.html
@@ -678,6 +678,7 @@ <h4>API Methods</h4>
 // perform some asynchronous task and manually move to next step
 boarding.preventMove();
 boarding.continue(); // Continue the move that was prevented using preventMove
+boarding.clearMovePrevented(); // preventMove will just "pause" the tour. If you want to clear that paused state, you can call clearMovePrevented, to clean up that paused state. You should do this, when your logic has a condition where it never calls continue
 
 // Gets the currently highlighted element on screen
 const activeElement = boarding.getHighlightedElement();

diff --git a/readme.md b/readme.md
@@ -352,6 +352,7 @@ boarding.hasPreviousStep(); // Checks if there is previous step to move to
 // perform some asynchronous task and manually move to next step
 boarding.preventMove();
 boarding.continue(); // Continue the move that was prevented using preventMove
+boarding.clearMovePrevented(); // preventMove will just "pause" the tour. If you want to clear that paused state, you can call clearMovePrevented, to clean up that paused state. You should do this, when your logic has a condition where it never calls continue
 
 // Highlights the element using query selector or the step definition
 boarding.highlight(string | stepDefinition);