@quenty/basicpane 5.2.0 → 6.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.
 
+# [6.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@5.2.0...@quenty/basicpane@6.0.0) (2022-08-14)
+
+
+### Features
+
+* Add BasicPaneUtils.whenVisibleBrio(createBasicPane) which allows for guis only while visible. ([05dd547](https://github.com/Quenty/NevermoreEngine/commit/05dd54729f9dd53348d24150e60a4bd5fc9fcea1))
+
+
+
+
+
 # [5.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@5.1.0...@quenty/basicpane@5.2.0) (2022-07-31)
 
 **Note:** Version bump only for package @quenty/basicpane

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/basicpane",
-  "version": "5.2.0",
+  "version": "6.0.0",
   "description": "Base UI object with visibility and a maid",
   "keywords": [
     "Roblox",
@@ -25,13 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
+    "@quenty/brio": "^7.0.0",
     "@quenty/loader": "^5.0.0",
     "@quenty/maid": "^2.4.0",
-    "@quenty/rx": "^5.2.0",
+    "@quenty/rx": "^6.0.0",
     "@quenty/signal": "^2.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e31b3a35aa475bb5699a24898a8639e107165b36"
+  "gitHead": "dbb62609f980983cc32da90acfef13e30ed41113"
 }

package/src/Client/BasicPaneUtils.lua

@@ -8,6 +8,7 @@ local Observable = require("Observable")
 local Maid = require("Maid")
 local Rx = require("Rx")
 local BasicPane = require("BasicPane")
+local Brio = require("Brio")
 
 local BasicPaneUtils = {}
 
@@ -31,6 +32,88 @@ function BasicPaneUtils.observeVisible(basicPane)
 	end)
 end
 
+--[=[
+	Shows the basic pane only when the emitting observable is visible. This
+	allows the basic pane 1 second to hide. If the pane gets reshown in that
+	time it will reshow it.
+
+	This can help lead to performance gains when you have a generally hidden pane
+	underneath another one and it needs to be shown.
+
+	See [GuiVisibleManager] for the OOP version.
+
+	```lua
+	Rx.of(true):Pipe({
+		BasicPaneUtils.whenVisibleBrio(function(maid)
+			-- generally you'd have your subclass here
+			local pane = BasicPane.new()
+			pane.Gui.Parent = screenGui
+
+			return pane
+		end)
+	})
+	```
+
+	@param createBasicPane (maid: Maid) -> BasicPane
+	@return (source: Observable<boolean>) -> Observable<Brio<GuiBase>>
+]=]
+function BasicPaneUtils.whenVisibleBrio(createBasicPane)
+	return function(source)
+		return Observable.new(function(sub)
+			local maid = Maid.new()
+
+			local currentPane = nil
+
+			local function ensurePane()
+				if currentPane then
+					return currentPane
+				end
+
+				local paneMaid = Maid.new()
+
+				local basicPane = createBasicPane(paneMaid)
+				assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
+				paneMaid:GiveTask(basicPane)
+
+				local brio = Brio.new(basicPane.Gui)
+				paneMaid:GiveTask(brio)
+
+				do
+					currentPane = basicPane
+					maid:GiveTask(function()
+						if currentPane == basicPane then
+							currentPane = nil
+						end
+					end)
+				end
+
+				-- Fire off
+				maid._currentPaneMaid = paneMaid
+				sub:Fire(brio)
+
+				return currentPane
+			end
+
+			maid:GiveTask(source:Subscribe(function(isVisible)
+				if isVisible then
+					maid._hideTask = nil
+					ensurePane():Show()
+				else
+					if currentPane and currentPane:IsVisible() then
+						currentPane:Hide()
+						maid._hideTask = task.delay(1, function()
+							currentPane = nil
+							maid._currentPaneMaid = nil
+						end)
+					end
+				end
+			end))
+
+			return maid
+		end)
+	end
+end
+
 --[=[
 	Observes percent visibility
 	@param basicPane BasicPane