@quenty/scrollingframe
v12.10.0
Published
Creates an inertia based scrolling frame that is animated and has inertia frames Alternative to a Roblox ScrollingFrame with inertia scrolling and complete control over behavior and style
Downloads
487
Maintainers
Readme
ScrollingFrame
Creates an inertia based scrolling frame that is animated and has inertia frames Alternative to a Roblox ScrollingFrame with inertia scrolling and complete control over behavior and style.
Somewhat less recommended these days because Roblox has added inertia scrolling to the mobile experience.
Installation
npm install @quenty/scrollingframe --save
Usage
Usage is designed to be simple.
ScrollingFrame.new(gui)
Creates a new ScrollingFrame which can be used. Prefer Container.Active = true so scroll wheel works.
ScrollingFrame:SetScrollType(scrollType)
Sets the scroll type for the frame
ScrollingFrame:AddScrollbar(scrollbar)
ScrollingFrame:RemoveScrollbar(scrollbar)
ScrollingFrame:ScrollTo(position, doNotAnimate)
Scrolls to the position in pixels offset
ScrollingFrame:ScrollToTop(doNotAnimate)
Scrolls to the top
ScrollingFrame:ScrollToBottom(doNotAnimate)
Scrolls to the bottom
ScrollingFrame:GetModel()
ScrollingFrame:StopDrag()
ScrollingFrame:BindInput(gui, options)
Binds input to a specific GUI