useScroll
Хук предоставляет единый API для чтения и управления прокруткой из контекста AppRoot.
Корректно работает с режимами scroll="contain" и scroll="global", а также с блокировкой через useScrollLock.
Обязательные условия
API
Возвращаемое значение
Объект с методами:
| Метод | Тип | Описание |
|---|---|---|
getScroll | (options?: GetScrollOptions) => { x: number; y: number } | Возвращает текущие координаты прокрутки |
scrollTo | (x?: number, y?: number) => void | Прокручивает к указанным координатам |
Особенности работы
Параметр scroll в AppRoot
В зависимости от значения свойства scroll компонента AppRoot меняется поведение useScroll:
scroll | Поведение |
|---|---|
"contain" | Управляет прокруткой внутреннего контейнера приложения. |
"global" | Работает с глобальной полосой прокрутки окна браузера. |