@quenty/scrollingframe

12.2.0 • Public • Published

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

ScrollingFrame:StartScrolling(inputBeganObject, options)

ScrollingFrame:StartScrollbarScrolling(scrollbarContainer, inputBeganObject)

ScrollingFrame:Destroy()

Package Sidebar

Install

npm i @quenty/scrollingframe

Weekly Downloads

257

Version

12.2.0

License

MIT

Unpacked Size

29.9 kB

Total Files

10

Last publish

Collaborators

  • quenty