@quenty/basicpane 3.1.3-canary.c50dead.0 → 3.2.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.1.3-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@3.1.2...@quenty/basicpane@3.1.3-canary.c50dead.0) (2021-11-20)
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@3.2.0...@quenty/basicpane@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/basicpane
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@3.1.2...@quenty/basicpane@3.2.0) (2021-11-20)
 
 
 ### Bug Fixes
 
-* Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
+* Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
 
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## BasicPane
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </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" />
@@ -13,25 +13,9 @@
 
 Base UI object with visibility and a maid
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/BasicPane">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/basicpane --save
 ```
-
-## Usage
-Usage is designed to be simple.
-
-### `BasicPane.new(gui)`
-
-### `BasicPane:SetVisible(isVisible, doNotAnimate)`
-
-### `BasicPane:Show(doNotAnimate)`
-
-### `BasicPane:Hide(doNotAnimate)`
-
-### `BasicPane:Toggle(doNotAnimate)`
-
-### `BasicPane:IsVisible()`
-
-### `BasicPane:Destroy()`
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/basicpane",
-  "version": "3.1.3-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "Base UI object with visibility and a maid",
   "keywords": [
     "Roblox",
@@ -25,12 +25,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/signal": "2.0.0"
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2",
+    "@quenty/signal": "^2.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/BasicPane.lua

@@ -1,6 +1,7 @@
---- Base UI object with visibility and a maid
--- @classmod BasicPane
--- @author Quenty
+--[=[
+	Base UI object with visibility and a maid
+	@class BasicPane
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -11,8 +12,30 @@ local BasicPane = {}
 BasicPane.__index = BasicPane
 BasicPane.ClassName = "BasicPane"
 
----
--- @param[opt] gui
+--[=[
+	Gui object which can be reparented or whatever
+
+	@prop Gui Instance?
+	@within BasicPane
+]=]
+--[=[
+	Fires whenever visibility changes. FIres with isVisible, doNotAnimate, and a maid which
+	has the lifetime of the visibility.
+
+	:::info
+	Do not use the Maid if you want the code to work in Deferred signal mode.
+	:::
+
+	@prop VisibleChanged Signal<boolean, boolean, Maid>
+	@within BasicPane
+]=]
+
+--[=[
+	Constructs a new BasicPane with the .Gui property set.
+
+	@param gui GuiBase? -- Optional Gui object
+	@return BasicPane
+]=]
 function BasicPane.new(gui)
 	local self = setmetatable({}, BasicPane)
 
@@ -33,6 +56,12 @@ function BasicPane.new(gui)
 	return self
 end
 
+--[=[
+	Sets the BasicPane to be visible
+
+	@param isVisible boolean -- Whether or not the pane should be visible
+	@param doNotAnimate boolean? -- True if this visiblity should not animate
+]=]
 function BasicPane:SetVisible(isVisible, doNotAnimate)
 	assert(type(isVisible) == "boolean", "Bad isVisible")
 
@@ -45,22 +74,42 @@ function BasicPane:SetVisible(isVisible, doNotAnimate)
 	end
 end
 
+--[=[
+	Shows the pane
+	@param doNotAnimate boolean? -- True if this visiblity should not animate
+]=]
 function BasicPane:Show(doNotAnimate)
 	self:SetVisible(true, doNotAnimate)
 end
 
+--[=[
+	Hides the pane
+	@param doNotAnimate boolean? -- True if this visiblity should not animate
+]=]
 function BasicPane:Hide(doNotAnimate)
 	self:SetVisible(false, doNotAnimate)
 end
 
+--[=[
+	Toggles the pane
+	@param doNotAnimate boolean? -- True if this visiblity should not animate
+]=]
 function BasicPane:Toggle(doNotAnimate)
 	self:SetVisible(not self._visible, doNotAnimate)
 end
 
+--[=[
+	Returns if the pane is visible
+	@return boolean
+]=]
 function BasicPane:IsVisible()
 	return self._visible
 end
 
+--[=[
+	Cleans up the BasicPane, invoking Maid:DoCleaning() on the BasicPane and
+	setting the metatable to nil.
+]=]
 function BasicPane:Destroy()
 	self._maid:DoCleaning()
 	self._maid = nil