Skip to content

Commit cd2d6e2

Browse files
committed
Improve AutoScroll docs
1 parent 84a9b60 commit cd2d6e2

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

plugins/AutoScroll/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,11 @@ Demo:
4949

5050

5151
#### `scrollFn` option
52-
Defines function that will be used for autoscrolling. el.scrollTop/el.scrollLeft is used by default.
5352
Useful when you have custom scrollbar with dedicated scroll function.
54-
This function should return `'continue'` if it wishes to allow Sortable's native autoscrolling.
53+
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.
54+
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.
55+
56+
**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.**
5557

5658

5759
---
@@ -60,13 +62,17 @@ This function should return `'continue'` if it wishes to allow Sortable's native
6062
#### `scrollSensitivity` option
6163
Defines how near the mouse must be to an edge to start scrolling.
6264

65+
**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.**
66+
6367

6468
---
6569

6670

6771
#### `scrollSpeed` option
6872
The speed at which the window should scroll once the mouse pointer gets within the `scrollSensitivity` distance.
6973

74+
**Note that this option will only work on all browsers/devices if Sortable's `forceFallback: true` option is set.**
75+
7076

7177
---
7278

0 commit comments

Comments
 (0)