Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pause until element becomes visible or event is triggered #157

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Pause until element becomes visible or event is triggered #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16977a8
pause until an element becomes visible or event is triggered
Jan 11, 2021
7ea5ebf
proapgate changes to the right source file
Jan 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 61 additions & 6 deletions enjoyhint.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
var SHAPE_BACKGROUND_COLOR = _options.backgroundColor || "rgba(0,0,0,0.6)";

var body = "body"; // TODO: Is it possible case when we need to define enjoyhint somewhere else?
var elementAvailableEventName = "enjoyhint-element-available";

var defaults = {
onStart: function() {},
Expand Down Expand Up @@ -97,7 +98,7 @@
$body.enjoyhint("hide_skip");
};

var stepAction = function() {
var stepAction = function(unpause) {
if (!(data && data[current_step])) {
$body.enjoyhint("hide");
options.onEnd();
Expand All @@ -113,9 +114,63 @@
$enjoyhint.removeClass("enjoyhint-step-" + (current_step + 1));
$enjoyhint.removeClass("enjoyhint-step-" + (current_step + 2));
$enjoyhint.addClass("enjoyhint-step-" + (current_step + 1));

var step_data = data[current_step];

$body.off(elementAvailableEventName);

//loops waiting until specified element becomes visible
var waitUntilAvailable = function (selector, interval) {
if (interval == null)
interval = 150;

var triggerIfAvailable = function () {
if ($(selector).is(":visible")) {
$body.trigger(elementAvailableEventName);
}
else {
setTimeout(triggerIfAvailable, interval)
}
};

setTimeout(triggerIfAvailable, 0);
}

//if pausedUntil was specified, hide current overlay and wait until specified event occurs
if (!unpause && step_data.pausedUntil != null && step_data.pausedUntil.event != null) {
//hide current overlay during waiting time
$body.enjoyhint("hide");

//if 'available' event was chosen wait for the custom event, which is triggered when the element becomes visible
if (step_data.pausedUntil.event === 'available') {
$body.on(elementAvailableEventName, function () {
stepAction(true); //restart the step without pause
$body.off(elementAvailableEventName);
});

//check if element is available every 150ms
waitUntilAvailable(step_data.pausedUntil.selector);
}
else {
//delay the actual action until 'the event' happens on body or selector
if (step_data.pausedUntil.selector == null) {
on(step_data.pausedUntil.event, function () {
stepAction(true); //restart the step without pause
off(step_data.pausedUntil.event);
});
}
else {
$(step_data.pausedUntil.selector).on(step_data.pausedUntil.event, function () {
stepAction(true); //restart the step without pause
$(step_data.pausedUntil.selector).off(step_data.pausedUntil.event)
});
}
}

//the rest of the logic will be executed whenever the step is restarted
return;
}

var scrollSpeed = step_data.scrollAnimationSpeed;

if (
Expand Down Expand Up @@ -1437,10 +1492,10 @@
else {
distance = initial_distance;
ver_button_position = initial_ver_position;
that.$next_btn.html(customBtnProps.nextButton && customBtnProps.nextButton.text ?
customBtnProps.nextButton.text : 'Next');
that.$prev_btn.html(customBtnProps.prevButton && customBtnProps.prevButton.text ?
customBtnProps.prevButton.text : 'Previous');
that.$next_btn.html(customBtnProps.nextButton && customBtnProps.nextButton.text ?
customBtnProps.nextButton.text : 'Next');
that.$prev_btn.html(customBtnProps.prevButton && customBtnProps.prevButton.text ?
customBtnProps.prevButton.text : 'Previous');
}

that.$prev_btn.css({
Expand Down
Loading