Skip to content

Commit 7408673

Browse files
committed
Further improve AutoScroll docs
1 parent cd2d6e2 commit 7408673

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

plugins/AutoScroll/README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,12 @@ Useful when you have custom scrollbar with dedicated scroll function.
5353
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.
5454
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.
5555

56-
**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.**
56+
**Note that this option will only work if Sortable's autoscroll function is invoked.**
57+
58+
It is invoked if any of the following are true:
59+
- The `forceFallback: true` option is set
60+
- It is a mobile device
61+
- The browser is either Safari, Internet Explorer, or Edge
5762

5863

5964
---
@@ -62,7 +67,12 @@ This function should return `'continue'` if it wishes to allow Sortable's native
6267
#### `scrollSensitivity` option
6368
Defines how near the mouse must be to an edge to start scrolling.
6469

65-
**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.**
70+
**Note that this option will only work if Sortable's autoscroll function is invoked.**
71+
72+
It is invoked if any of the following are true:
73+
- The `forceFallback: true` option is set
74+
- It is a mobile device
75+
- The browser is either Safari, Internet Explorer, or Edge
6676

6777

6878
---
@@ -71,8 +81,12 @@ Defines how near the mouse must be to an edge to start scrolling.
7181
#### `scrollSpeed` option
7282
The speed at which the window should scroll once the mouse pointer gets within the `scrollSensitivity` distance.
7383

74-
**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.**
84+
**Note that this option will only work if Sortable's autoscroll function is invoked.**
7585

86+
It is invoked if any of the following are true:
87+
- The `forceFallback: true` option is set
88+
- It is a mobile device
89+
- The browser is either Safari, Internet Explorer, or Edge
7690

7791
---
7892

0 commit comments

Comments
 (0)