Перейти к содержимому

CustomScrollView

Компонент, который унифицирует браузерную полосу прокрутки на всех платформах.

Контент, который требует полосы прокрутки, необходимо передавать в свойство children.

Свойство overscrollBehavior отвечает за поведение при достижении границы области прокрутки. Подробнее с поведением и значениями можно ознакомиться в документации overscrollBehavior ↗.

Свойство scrollBehavior отвечает за анимацию прокрутки. Подробнее с поведением и значениями можно ознакомиться в документации scroll-behavior ↗.

Свойство scrollbarHidden позволяет управлять видимостью полосы прокрутки.

  • true — полоса прокрутки скрыта;
  • false — полоса прокрутки видна (по умолчанию).

Свойство enableHorizontalScroll позволяет отображать горизонтальную полосу прокрутки.

  • true — горизонтальная полоса прокрутки видна;
  • false — горизонтальная полоса прокрутки скрыта (по умолчанию).

Компонент позволяет обрабатывать событие scroll, возникающее при прокрутке контента, через свойство onScroll.

Хук, который добавляет тени к краям прокручиваемой области через CSS-маску (maskImage). Маска реагирует на положение прокрутки: тень появляется только у тех краёв, за которыми есть ещё контент.

Хук возвращает объект с тремя свойствами, которые нужно передать прокручиваемому элементу:

  • getRootRef — референс на прокручиваемый элемент;
  • onScroll — обработчик события scroll;
  • style — объект стилей с maskImage и maskComposite (необходимо применить к прокручиваемому элементу).
СвойствоОписание
enableHorizontalScrollboolean

Включение отображения горизонтального скролла.

По умолчанию: false
getRootRefRef<HTMLDivElement>
По умолчанию: -
overscrollBehavior"none" | "auto" | "contain"

Поведение overscroll, подробнее можно почитать в документации ↗.

По умолчанию: auto
scrollbarHiddenboolean

Скрытие скроллбара.

По умолчанию: false
scrollBehavior"auto" | "smooth"

Поведение scroll-behavior, подробнее можно почитать в документации ↗.

По умолчанию: auto