@quenty/scrollingframe 3.4.0 → 4.0.1-canary.238.2c4d310.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.1-canary.238.2c4d310.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/scrollingframe@4.0.0...@quenty/scrollingframe@4.0.1-canary.238.2c4d310.0) (2021-12-29)
+
+**Note:** Version bump only for package @quenty/scrollingframe
+
+
+
+
+
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/scrollingframe@3.4.0...@quenty/scrollingframe@4.0.0) (2021-12-22)
+
+**Note:** Version bump only for package @quenty/scrollingframe
+
+
+
+
+
 # [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/scrollingframe@3.3.0...@quenty/scrollingframe@3.4.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/scrollingframe

package/README.md

@@ -1,10 +1,10 @@
 ## ScrollingFrame
 <div align="center">
-  <a href="http://quenty.github.io/api/">
+  <a href="http://quenty.github.io/NevermoreEngine/">
     <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/scrollingframe",
-  "version": "3.4.0",
+  "version": "4.0.1-canary.238.2c4d310.0",
   "description": "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",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1",
-    "@quenty/maid": "^2.0.1",
-    "@quenty/signal": "^2.0.0",
-    "@quenty/spring": "^2.2.0",
-    "@quenty/table": "^2.1.0"
+    "@quenty/loader": "3.1.2-canary.238.2c4d310.0",
+    "@quenty/maid": "2.0.2-canary.238.2c4d310.0",
+    "@quenty/signal": "2.0.1-canary.238.2c4d310.0",
+    "@quenty/spring": "3.0.1-canary.238.2c4d310.0",
+    "@quenty/table": "2.1.1-canary.238.2c4d310.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
+  "gitHead": "2c4d310b84afd0570d89667dc5d4aa69a0ef304a"
 }

package/src/Client/SCROLL_TYPE.lua

@@ -1,5 +1,7 @@
---- ScrollType enum, determines scrolling behavior
--- @module ScrollType
+--[=[
+	ScrollType enum, determines scrolling behavior
+	@class ScrollType
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/ScrollModel.lua

@@ -1,5 +1,7 @@
---- Scrolling model for scrolling frame
--- @module ScrollModel
+--[=[
+	Scrolling model for scrolling frame
+	@class ScrollModel
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/Scrollbar.lua

@@ -1,5 +1,6 @@
----
--- @classmod Scrollbar
+--[=[
+	@class Scrollbar
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Client/ScrollingFrame.lua

@@ -1,6 +1,10 @@
---- 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
--- @classmod 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.
+
+	@deprecated 1.0.0
+	@class ScrollingFrame
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -16,8 +20,13 @@ local ScrollingFrame = {}
 ScrollingFrame.ClassName = "ScrollingFrame"
 ScrollingFrame.__index = ScrollingFrame
 
---- Creates a new ScrollingFrame which can be used. Prefer Container.Active = true so scroll wheel works.
--- Container should be in a Frame with ClipsDescendants = true
+--[=[
+	Creates a new ScrollingFrame which can be used. Prefer Container.Active = true so scroll wheel works.
+	Container should be in a Frame with ClipsDescendants = true
+
+	@param gui BaseGui -- Gui to use
+	@return ScrollingFrame
+]=]
 function ScrollingFrame.new(gui)
 	local self = setmetatable({}, ScrollingFrame)
 
@@ -48,7 +57,7 @@ function ScrollingFrame.new(gui)
 	return self
 end
 
---- Sets the scroll type for the frame
+-- Sets the scroll type for the frame
 function ScrollingFrame:SetScrollType(scrollType)
 	assert(Table.contains(SCROLL_TYPE, scrollType))
 	self._scrollType = scrollType
@@ -70,7 +79,7 @@ function ScrollingFrame:RemoveScrollbar(scrollbar)
 	end
 end
 
---- Scrolls to the position in pixels offset
+-- Scrolls to the position in pixels offset
 function ScrollingFrame:ScrollTo(position, doNotAnimate)
 	self._model.Target = position
 	if doNotAnimate then
@@ -79,12 +88,12 @@ function ScrollingFrame:ScrollTo(position, doNotAnimate)
 	end
 end
 
---- Scrolls to the top
+-- Scrolls to the top
 function ScrollingFrame:ScrollToTop(doNotAnimate)
 	self:ScrollTo(self._model.Min, doNotAnimate)
 end
 
---- Scrolls to the bottom
+-- Scrolls to the bottom
 function ScrollingFrame:ScrollToBottom(doNotAnimate)
 	self:ScrollTo(self._model.Max, doNotAnimate)
 end
@@ -130,7 +139,7 @@ function ScrollingFrame:StopDrag()
 	self:_freeScroll()
 end
 
---- Scrolls until model is at rest
+-- Scrolls until model is at rest
 function ScrollingFrame:_freeScroll(lowPriority)
 	if lowPriority and self._maid._updateMaid then
 		return
@@ -149,7 +158,7 @@ function ScrollingFrame:_freeScroll(lowPriority)
 	self._maid._updateMaid = maid
 end
 
----
+--
 -- @param[opt=1] strength
 function ScrollingFrame:_getVelocityTracker(strength)
 	strength = strength or 1
@@ -193,8 +202,8 @@ end
 
 
 
---- Binds input to a specific GUI
--- @treturn Maid maid to cleanup inputs
+-- Binds input to a specific GUI
+-- @return maid Maid -- To cleanup inputs
 function ScrollingFrame:BindInput(gui, options)
 	local maid = Maid.new()