@quenty/snackbar 3.2.1-canary.8533eea.0 → 3.3.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.2.1-canary.8533eea.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/snackbar@3.2.0...@quenty/snackbar@3.2.1-canary.8533eea.0) (2021-12-18)
+## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/snackbar@3.3.0...@quenty/snackbar@3.3.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/snackbar
+
+
+
+
+
+# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/snackbar@3.2.0...@quenty/snackbar@3.3.0) (2021-12-18)
 
 
 ### Bug Fixes
 
-* use task.delay() instead of delay() ([899db74](https://github.com/Quenty/NevermoreEngine/commit/899db7401c30825f32cb3583777c8a2d9fb5a4df))
+* use task.delay() instead of delay() ([f3171d4](https://github.com/Quenty/NevermoreEngine/commit/f3171d409226dd38306818fa429136746ad4d213))
 
 
 

package/README.md

@@ -1,10 +1,10 @@
 ## Snackbar
 <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,6 +13,8 @@
 
 Snackbars provide lightweight feedback on an operation at the base of the screen. They automatically disappear after a timeout or user interaction. There can only be one on the screen at a time.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/Snackbar">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/snackbar --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/snackbar",
-  "version": "3.2.1-canary.8533eea.0",
+  "version": "3.3.1",
   "description": "Snackbars provide lightweight feedback on an operation at the base of the screen. They automatically disappear after a timeout or user interaction. There can only be one on the screen at a time.",
   "keywords": [
     "Roblox",
@@ -25,13 +25,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/math": "2.0.0",
-    "@quenty/qgui": "2.0.0"
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2",
+    "@quenty/math": "^2.0.1",
+    "@quenty/qgui": "^2.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8533eeade3bf6835c0295785c1c326b9abee3222"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/DraggableSnackbar.lua

@@ -1,5 +1,7 @@
---- Snackbar, but draggable
--- @classmod DraggableSnackbar
+--[=[
+	Snackbar, but draggable
+	@class DraggableSnackbar
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -21,7 +23,7 @@ DraggableSnackbar.Duration = 3
 -- By default the Snackbar will close automatically if the user types outside or presses the esc key.
 DraggableSnackbar.AutoCloseDisabled = false
 
---- Note that this will not show until :Show() is called
+-- Note that this will not show until :Show() is called
 -- @constructor
 -- @param [GCOnDismissal] If true, will destroy itself and GC after being dismissed. Defaults to true
 -- @param [Options] Table of optional values, adds call to actions, et cetera
@@ -88,7 +90,7 @@ function DraggableSnackbar:Show()
 			end
 		end))
 
-		--- Setup hide on dismissal
+		-- Setup hide on dismissal
 		task.delay(self.Duration, function()
 			if self.Destroy and self._showId == LocalShowId and self._visible then
 				self:Dismiss()

package/src/Client/Snackbar.lua

@@ -1,8 +1,10 @@
---- Snackbars provide lightweight feedback on an operation
--- at the base of the screen. They automatically disappear
--- after a timeout or user interaction. There can only be
--- one on the screen at a time.
--- @classmod Snackbar
+--[=[
+	Snackbars provide lightweight feedback on an operation
+	at the base of the screen. They automatically disappear
+	after a timeout or user interaction. There can only be
+	one on the screen at a time.
+	@class Snackbar
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -52,7 +54,7 @@ function Snackbar.new(Parent, Text, options)
 	ShadowContainer.Archivable = false
 	ShadowContainer.Position = UDim2.new(0.5, 0, 0.5, 0)
 
-	--- Image is blurred at
+	-- Image is blurred at
 	self.ShadowImages = {
 		qGUI.AddNinePatch(ShadowContainer, "rbxassetid://191838004",
 			Vector2.new(150, 150),
@@ -204,7 +206,7 @@ function Snackbar:FadeOutTransparency(PercentFaded)
 	end
 end
 
---- Will animate unless given PercentFaded
+-- Will animate unless given PercentFaded
 function Snackbar:FadeInTransparency(PercentFaded)
 	if PercentFaded then
 		-- self.Gui.BackgroundTransparency = Math.map(PercentFaded, 0, 1, 1, 0)

package/src/Client/SnackbarManager.lua

@@ -1,5 +1,7 @@
---- Guarantees that only one snackbar is visible at once
--- @module SnackbarManager
+--[=[
+	Guarantees that only one snackbar is visible at once
+	@class SnackbarManager
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -12,14 +14,19 @@ function SnackbarManager:Init(screenGui)
 	self:WithScreenGui(screenGui)
 end
 
---- Sets the screenGui to use
+--[=[
+	Sets the screenGui to use
+
+	@param screenGui ScreenGui
+	@return SnackbarManager
+]=]
 function SnackbarManager:WithScreenGui(screenGui)
 	self._screenGui = screenGui or error("No screenGui")
 
 	return self
 end
 
---- Automatically makes a snackbar and shows it
+-- Automatically makes a snackbar and shows it
 -- @param text to show
 -- @param[opt] options
 --[[
@@ -40,7 +47,6 @@ function SnackbarManager:MakeSnackbar(text, options)
 	return snackbar
 end
 
---- Cleanup existing snackbar
 function SnackbarManager:_showSnackbar(snackbar)
 	assert(snackbar, "Must send a snackbar")