From 155bb3ad21121e3f0792bb9c90c7a651e9aeac94 Mon Sep 17 00:00:00 2001 From: Moritz Date: Mon, 12 Feb 2018 10:13:47 -0600 Subject: [PATCH] updated docs --- readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.md b/readme.md index 0f9341d..88d21be 100644 --- a/readme.md +++ b/readme.md @@ -14,6 +14,7 @@ Scrollimate focuses on features and functions related to scrolling, animations ( - [Mobile Control](#saParallaxAdvanced) - [SA (Smooth Anchor) Scroll](#saScroll) - [Basic Setup](#saScrollBasic) + - [Advanced Setup](#saScrollAdvanced) - [SA Tabs](#saTabs) - [Markup](#saTabsMarkup) - [Setup](#saTabsSetup) @@ -142,6 +143,18 @@ Smoothly scrolls to elements on websites that contain anchor scrolls. Instead of 1. Follow the Instructions for Scrollimate Installation 2. Call the Method once on the page: `` (You may also use the init function by supplying 'saScroll' as an additional argument) +#### ADVANCED SETUP: + +The above method cancels any scroll on user-input, in order to preserve and respect the user's scroll before the automatic scroll. +Alternatively, you can *force* the scroll by calling the method with a force argument like so: + +`scrollimate.saScroll('force')` + +As with any method called with arguments, you can currently NOT call this functionality via the init method. + +_ + + --- ---