From 7408673c81d4676159d6b0ac3d91573b7e3e0359 Mon Sep 17 00:00:00 2001 From: owen-m1 Date: Tue, 5 Jan 2021 21:58:31 -0500 Subject: [PATCH] Further improve AutoScroll docs --- plugins/AutoScroll/README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/plugins/AutoScroll/README.md b/plugins/AutoScroll/README.md index 946904877..55e481144 100644 --- a/plugins/AutoScroll/README.md +++ b/plugins/AutoScroll/README.md @@ -53,7 +53,12 @@ Useful when you have custom scrollbar with dedicated scroll function. Defines a function that will be used for autoscrolling. Sortable uses el.scrollTop/el.scrollLeft by default. Set this option if you wish to handle it differently. This function should return `'continue'` if it wishes to allow Sortable's native autoscrolling, otherwise Sortable will not scroll anything if this option is set. -**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.** +**Note that this option will only work if Sortable's autoscroll function is invoked.** + +It is invoked if any of the following are true: + - The `forceFallback: true` option is set + - It is a mobile device + - The browser is either Safari, Internet Explorer, or Edge --- @@ -62,7 +67,12 @@ This function should return `'continue'` if it wishes to allow Sortable's native #### `scrollSensitivity` option Defines how near the mouse must be to an edge to start scrolling. -**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.** +**Note that this option will only work if Sortable's autoscroll function is invoked.** + +It is invoked if any of the following are true: + - The `forceFallback: true` option is set + - It is a mobile device + - The browser is either Safari, Internet Explorer, or Edge --- @@ -71,8 +81,12 @@ Defines how near the mouse must be to an edge to start scrolling. #### `scrollSpeed` option The speed at which the window should scroll once the mouse pointer gets within the `scrollSensitivity` distance. -**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.** +**Note that this option will only work if Sortable's autoscroll function is invoked.** +It is invoked if any of the following are true: + - The `forceFallback: true` option is set + - It is a mobile device + - The browser is either Safari, Internet Explorer, or Edge ---