0.5.3 • Published 4 days ago

@snack-uikit/scroll v0.5.3

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 days ago

Scroll

Installation

npm i @snack-uikit/scroll

Changelog

Scroll

Props

nametypedefault valuedescription
classNamestring-CSS-класс
sizeenum Size: "s", "m"mРазмер скролбаров
clickScrollingbooleantrueСкролить ли по клику в скроллбар.
autoscrollToenum AutoscrollTo: "bottom", "right"-Включает автоскрол при маунте и изменении размера контента: - bottom - автоскрол вниз, - right - автоскрол вправо,
barHideStrategyenum BarHideStrategy: "never", "leave", "scroll", "move"leaveУправление скрытием скролл баров: - Never - показывать всегда - Leave - скрывать когда курсор покидает компонент - Scroll - показывать только когда происходит скроллинг - Move - показывать при движении курсора над компонентом
onScroll(event?: Event) => void-Колбек события скрола.
resizeenum Resize: "none", "horizontal", "vertical", "both"noneНастройка возможности регулировать Scroll-контейнер: - None - нельзя изменять размер - Horizontal - можно изменять размер только по горизонтали - Vertical - можно изменять размер только по вертикали - Both - можно изменять размер в обеих координатах
untouchableScrollbarsboolean-Отключает возможность взаимодействовать со скролбарами мышью.
refRef<HTMLElement>-Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref). @see https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom
keyKey-