@quenty/buttonhighlightmodel 3.6.0 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@3.6.0...@quenty/buttonhighlightmodel@4.0.0) (2022-03-06)
+
+
+### Features
+
+* ButtonHighlightModel can assign the button at any point which allows for use in Blend ([7010810](https://github.com/Quenty/NevermoreEngine/commit/701081083ddb40e9cb82df984594187386ab85df))
+
+
+
+
+
 # [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@3.5.1...@quenty/buttonhighlightmodel@3.6.0) (2022-01-17)
 
 **Note:** Version bump only for package @quenty/buttonhighlightmodel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/buttonhighlightmodel",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "description": "Contains model information for the current button",
   "keywords": [
     "Roblox",
@@ -27,15 +27,15 @@
   ],
   "dependencies": {
     "@quenty/acceltween": "^2.1.0",
-    "@quenty/baseobject": "^3.5.0",
-    "@quenty/blend": "^2.3.0",
-    "@quenty/loader": "^3.4.0",
+    "@quenty/baseobject": "^4.0.0",
+    "@quenty/blend": "^3.0.0",
+    "@quenty/loader": "^4.0.0",
     "@quenty/maid": "^2.1.0",
-    "@quenty/rx": "^3.8.0",
+    "@quenty/rx": "^4.0.0",
     "@quenty/steputils": "^3.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
+  "gitHead": "dd428cab58282c975a4c082957dc8f58e3186905"
 }

package/src/Client/ButtonHighlightModel.lua

@@ -1,5 +1,35 @@
 --[=[
-	Contains model information for the current button
+	Contains model information for the current button.
+
+	Usage with Blend!
+
+	```lua
+	function Button.new()
+		local self = setmetatable(BaseObject.new(), Button)
+
+		-- Store the button model in the actual button so we can ensure it cleans up
+		-- this assumes only one render. We can also construct it in the Button.Render
+
+		self._buttonModel = ButtonHighlightModel.new()
+		self._maid:GiveTask(self._buttonModel)
+
+		return self
+	end
+
+	function Button:Render()
+		...
+		return Blend.New "ImageButton" {
+			...
+			[Blend.Instance] = function(button)
+				self._buttonModel:SetButton(button)
+			end;
+			BackgroundTransparency = Blend.Computed(self._buttonModel:ObservePercentPressed(), function(pressed)
+				return 1 - pressed
+			end);
+		}
+	end
+	```
+
 	@class ButtonHighlightModel
 ]=]
 
@@ -18,12 +48,12 @@ ButtonHighlightModel.__index = ButtonHighlightModel
 
 --[=[
 	A model that dictates the current state of a button.
-	@param button GuiBase
+	@param button? GuiBase
 	@param onUpdate function?
 	@return ButtonHighlightModel
 ]=]
 function ButtonHighlightModel.new(button, onUpdate)
-	local self = setmetatable(BaseObject.new(assert(button, "Bad button")), ButtonHighlightModel)
+	local self = setmetatable(BaseObject.new(), ButtonHighlightModel)
 
 	self._onUpdate = onUpdate
 
@@ -97,42 +127,6 @@ function ButtonHighlightModel.new(button, onUpdate)
 	self.IsPressed.Value = false
 	self._maid:GiveTask(self.IsPressed)
 
-	self._maid:GiveTask(self._obj.InputEnded:Connect(function(inputObject)
-		if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
-			self._isMouseOver.Value = false
-		end
-
-		if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
-			self._isMouseDown.Value = false
-		end
-
-		if inputObject.UserInputType == Enum.UserInputType.Touch then
-			self:_stopTouchTrack(inputObject)
-		end
-	end))
-
-	self._maid:GiveTask(self._obj.SelectionGained:Connect(function()
-		self.IsSelected.Value = true
-	end))
-
-	self._maid:GiveTask(self._obj.SelectionLost:Connect(function()
-		self.IsSelected.Value = false
-	end))
-
-	self._maid:GiveTask(self._obj.InputBegan:Connect(function(inputObject)
-		if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
-			self._isMouseOver.Value = true
-		end
-
-		if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
-			self._isMouseDown.Value = true
-		end
-
-		if inputObject.UserInputType == Enum.UserInputType.Touch then
-			self:_trackTouch(inputObject)
-		end
-	end))
-
 	-- Legacy update stepping mode
 	if self._onUpdate then
 		self._percentHighlightedAccelTween = AccelTween.new(200)
@@ -190,9 +184,63 @@ function ButtonHighlightModel.new(button, onUpdate)
 	end))
 	self:_updateTargets()
 
+	if button then
+		self:SetButton(button)
+	end
+
 	return self
 end
 
+--[=[
+	Sets the button for the highlight model.
+	@param button
+]=]
+function ButtonHighlightModel:SetButton(button: Instance)
+	assert(typeof(button) == "Instance" or button == nil, "Bad button")
+
+	local maid = Maid.new()
+
+	if button then
+		maid:GiveTask(button.InputEnded:Connect(function(inputObject)
+			if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
+				self._isMouseOver.Value = false
+			end
+
+			if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
+				self._isMouseDown.Value = false
+			end
+
+			if inputObject.UserInputType == Enum.UserInputType.Touch then
+				self:_stopTouchTrack(inputObject)
+			end
+		end))
+
+		maid:GiveTask(button.SelectionGained:Connect(function()
+			self.IsSelected.Value = true
+		end))
+
+		maid:GiveTask(button.SelectionLost:Connect(function()
+			self.IsSelected.Value = false
+		end))
+
+		maid:GiveTask(button.InputBegan:Connect(function(inputObject)
+			if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
+				self._isMouseOver.Value = true
+			end
+
+			if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
+				self._isMouseDown.Value = true
+			end
+
+			if inputObject.UserInputType == Enum.UserInputType.Touch then
+				self:_trackTouch(inputObject)
+			end
+		end))
+	end
+
+	self._maid._buttonMaid = maid
+end
+
 --[=[
 	Observes how pressed down the button is
 	@return Observable<number>
@@ -210,13 +258,21 @@ end
 	Observes how highlighted the button is
 	@return Observable<number>
 ]=]
-function ButtonHighlightModel:ObservePercentHiglighted()
-	return Blend.AccelTween(Blend.toPropertyObservable(self.IsHighlighted)
+function ButtonHighlightModel:ObservePercentHighlighted()
+	return Blend.AccelTween(self:ObservePercentHighlightedTarget(), 200)
+end
+
+--[=[
+	Observes target for how highlighted the button is
+	@return Observable<number>
+]=]
+function ButtonHighlightModel:ObservePercentHighlightedTarget()
+	return Blend.toPropertyObservable(self.IsHighlighted)
 		:Pipe({
 			Rx.map(function(value)
 				return value and 1 or 0
 			end);
-		}), 200)
+		})
 end
 
 --[=[