Skip to content

Commit 9a5ed0b

Browse files
authored
Clarify scrollCheck vs intervalCheck defaults
The readme suggests that scrollCheck is on and intervalCheck is off, but its the opposite. Happy to rewrite text if there is a clearer way to say this.
1 parent ae0643f commit 9a5ed0b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Props
6767
- `partialVisibility`: (default `false`) consider element visible if only part of it is visible. Also possible values are - 'top', 'right', 'bottom', 'left' - in case it's needed to detect when one of these become visible explicitly.
6868
- `offset`: (default `{}`) with offset you can define amount of px from one side when the visibility should already change. So in example setting `offset={{top:10}}` means that the visibility changes hidden when there is less than 10px to top of the viewport. Offset works along with `partialVisibility`
6969
- `minTopValue`: (default `0`) consider element visible if only part of it is visible and a minimum amount of pixels could be set, so if at least 100px are in viewport, we mark element as visible.
70-
- `intervalCheck`: (default `true`) the default usage of Visibility Sensor is to trigger a check on user scrolling, by checking this as true, it gives you the possibility to check if the element is in view even if it wasn't because of a user scroll
70+
- `intervalCheck`: (default `true`) the default usage of Visibility Sensor is to trigger a check on an interval, by leaving this as true, it checks if the element is in view even if it wasn't because of a user scroll
7171
- `intervalDelay`: (default `1500`) integer, number of milliseconds between checking the element's position in relation the the window viewport. Making this number too low will have a negative impact on performance.
7272
- `scrollCheck`: (default: `false`) by making this true, the scroll listener is enabled.
7373
- `scrollDelay`: (default: `250`) is the debounce rate at which the check is triggered. Ex: 250ms after the user stopped scrolling.

0 commit comments

Comments
 (0)