"onComplete" never gets called when user interrupts scroll animation

[mciastek]

When you set cancelOnUserAction to true and after scroll animation is interrupted by user's action, the onComplete never gets called. It would be nice to know if animated completed even if it was interrupted in the middle. I would like to help with PR, so just let me know if that's a good idea.

animated-scroll-to/animated-scroll-to.js

Lines 140 to 143 in 636752b

	handleUserEvent = function() {
	removeListeners();
	cancelAnimationFrame(requestID);
	};

[Stanko]

Hey @mciastek,

You are correct, it doesn't get called in that scenario. I thought about it for a while, and I think better solution would be to add a new property onUserCancelation (name is open for suggestion 🙈).

Honestly I never run into scenario where I needed that.

What do you think?

EDIT: It could be added here:
https://github.com/Stanko/animated-scroll-to/blob/master/animated-scroll-to.js#L140-L143

[mciastek]

Hi @Stanko! Thanks for responding to my issue!

Honestly, I'm not sure if I need to know if scroll animation has been interrupted by user or not. I would prefer having only one callback which tells me that animation ended. Simple as that. If such information is required I would add an argument to onComplete callback, which tells you if animated has been ended before it's done. What do you think about it?

[Stanko]

It probably makes sense to have one callback, and pass a boolean argument to it canceled. I'll create a change soon.

[mciastek]

Great! I'm happy to help with PR if needed.

[Stanko]

Published in v1.3.0 🎉 onComplete now receives a boolean argument isCanceledByUserAction

#27