@quenty/basicpane 3.2.2 → 3.3.0-canary.241.a4e8214.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.
 
+# [3.3.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@3.2.2...@quenty/basicpane@3.3.0-canary.241.a4e8214.0) (2022-01-03)
+
+
+### Features
+
+* Add BasicPaneUtils and BasicPane.isBasicPane(value) ([0acc78d](https://github.com/Quenty/NevermoreEngine/commit/0acc78d3d28606e036549ffae31fe75902fc45bc))
+
+
+
+
+
 ## [3.2.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@3.2.1...@quenty/basicpane@3.2.2) (2021-12-30)
 
 **Note:** Version bump only for package @quenty/basicpane

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/basicpane",
-  "version": "3.2.2",
+  "version": "3.3.0-canary.241.a4e8214.0",
   "description": "Base UI object with visibility and a maid",
   "keywords": [
     "Roblox",
@@ -25,12 +25,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.2",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/signal": "^2.0.2"
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
+    "@quenty/maid": "2.0.2",
+    "@quenty/rx": "3.6.0-canary.241.a4e8214.0",
+    "@quenty/signal": "2.1.0-canary.241.a4e8214.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4afdd64f4ff6bc3b4b4c0ca7a31e839196f2411e"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Client/BasicPane.lua

@@ -12,6 +12,23 @@ local BasicPane = {}
 BasicPane.__index = BasicPane
 BasicPane.ClassName = "BasicPane"
 
+--[=[
+	Returns whether the value is a basic pane
+	@param value any
+	@return boolean
+]=]
+function BasicPane.isBasicPane(value)
+	return type(value) == "table"
+		and Maid.isMaid(value._maid)
+		and Signal.isSignal(value.VisibleChanged)
+		and type(value.SetVisible) == "function"
+		and type(value.IsVisible) == "function"
+		and type(value.Show) == "function"
+		and type(value.Hide) == "function"
+		and type(value.Toggle) == "function"
+		and type(value.Destroy) == "function"
+end
+
 --[=[
 	Gui object which can be reparented or whatever
 

package/src/Client/BasicPaneUtils.lua

@@ -0,0 +1,75 @@
+--[=[
+	@class BasicPaneUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Observable = require("Observable")
+local Maid = require("Maid")
+local Rx = require("Rx")
+local BasicPane = require("BasicPane")
+
+local BasicPaneUtils = {}
+
+--[=[
+	Observes visibility
+	@param basicPane BasicPane
+	@return Observable<boolean>
+]=]
+function BasicPaneUtils.observeVisible(basicPane)
+	assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+
+		maid:GiveTask(basicPane.VisibleChanged:Connect(function(isVisible)
+			sub:Fire(isVisible)
+		end))
+		sub:Fire(basicPane:IsVisible())
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes percent visibility
+	@param basicPane BasicPane
+	@return Observable<number>
+]=]
+function BasicPaneUtils.observePercentVisible(basicPane)
+	assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
+
+	return BasicPaneUtils.observeVisible(basicPane):Pipe({
+		Rx.map(function(visible)
+			return visible and 1 or 0
+		end);
+		Rx.startWith({0}); -- Ensure fade in every time.
+	})
+end
+
+--[=[
+	Convert percentVisible observable to transparency
+
+	@function toTransparency
+	@param source Observable<number>
+	@return Observable<number>
+	@within BasicPaneUtils
+]=]
+BasicPaneUtils.toTransparency = Rx.map(function(value)
+	return 1 - value
+end)
+
+--[=[
+	Observes showing a basic pane
+	@param basicPane BasicPane
+	@return Observable<boolean>
+]=]
+function BasicPaneUtils.observeShow(basicPane)
+	return BasicPaneUtils.observeVisible(basicPane):Pipe({
+		Rx.where(function(isVisible)
+			return isVisible
+		end)
+	})
+end
+
+return BasicPaneUtils