From df21ab8f1e77484796f1bd7379a82f4d543af642 Mon Sep 17 00:00:00 2001 From: josias-r Date: Mon, 20 Mar 2023 14:16:55 +0100 Subject: [PATCH] chore(docs): document `clearMovePrevented` method --- index.html | 1 + readme.md | 1 + 2 files changed, 2 insertions(+) diff --git a/index.html b/index.html index 353212b..8b78042 100644 --- a/index.html +++ b/index.html @@ -678,6 +678,7 @@

API Methods

// 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 index a6c87fc..71d434b 100644 --- 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);