@quenty/colorpicker 4.3.1 → 4.3.2-canary.303.3e5dce0.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.3.2-canary.303.3e5dce0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorpicker@4.3.1...@quenty/colorpicker@4.3.2-canary.303.3e5dce0.0) (2022-11-08)
+
+**Note:** Version bump only for package @quenty/colorpicker
+
+
+
+
+
 ## [4.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorpicker@4.3.0...@quenty/colorpicker@4.3.1) (2022-11-04)
 
 **Note:** Version bump only for package @quenty/colorpicker

package/README.md

@@ -11,11 +11,11 @@
   </a>
 </div>
 
-Color selector UI
+A HSV color picker which allows you to select colors in the same way as Roblox Studio.
 
-<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/HSColorPicker">View docs →</a></div>
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/HSVColorPicker">View docs →</a></div>
 
 ## Installation
 ```
 npm install @quenty/colorpicker --save
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/colorpicker",
-  "version": "4.3.1",
+  "version": "4.3.2-canary.303.3e5dce0.0",
   "description": "Color picking UI system for Roblox.",
   "keywords": [
     "Roblox",
@@ -28,15 +28,15 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^6.0.1",
-    "@quenty/basicpane": "^7.1.1",
-    "@quenty/blend": "^6.3.1",
-    "@quenty/color3utils": "^5.3.1",
-    "@quenty/inputobjectutils": "^4.0.0",
-    "@quenty/instanceutils": "^7.1.1",
-    "@quenty/loader": "^6.0.1",
-    "@quenty/maid": "^2.4.0",
-    "@quenty/math": "^2.2.0"
+    "@quenty/baseobject": "6.0.1",
+    "@quenty/basicpane": "7.1.1",
+    "@quenty/blend": "6.3.1",
+    "@quenty/color3utils": "5.3.1",
+    "@quenty/inputobjectutils": "4.0.0",
+    "@quenty/instanceutils": "7.1.1",
+    "@quenty/loader": "6.0.1",
+    "@quenty/maid": "2.4.0",
+    "@quenty/math": "2.2.0"
   },
-  "gitHead": "8b9877c26a3fc753409a5114e56717837291279d"
+  "gitHead": "3e5dce0b249a270d35586e5897a36e84611e7834"
 }

package/src/Client/Cursor/HSColorPickerCursor.lua

@@ -1,4 +1,6 @@
 --[=[
+	The actual cursor for the HSV (it's a plus). See [HSVColorPicker].
+
 	@class HSColorPickerCursor
 ]=]
 
@@ -52,6 +54,11 @@ function HSColorPickerCursor.new()
 	return self
 end
 
+--[=[
+	Hints the background color so contrast can be set appropriately.
+
+	@param color Color3
+]=]
 function HSColorPickerCursor:HintBackgroundColor(color)
 	assert(typeof(color) == "Color3", "Bad color")
 
@@ -66,18 +73,38 @@ function HSColorPickerCursor:SetHorizontalHairVisible(visible)
 	self._horizontalHairVisible.Value = visible
 end
 
+--[=[
+	Sets the size of the cursor.
+
+	@param height number
+]=]
 function HSColorPickerCursor:SetHeight(height)
 	self._height.Value = height
 end
 
+--[=[
+	Sets the Vector2 position in scale (from 0 to 1).
+
+	@param position Vector2
+]=]
 function HSColorPickerCursor:SetPosition(position)
 	self._position.Value = position
 end
 
+--[=[
+	Gets the position of the cursor in scale
+
+	@return Vector2
+]=]
 function HSColorPickerCursor:GetPosition()
 	return self._position.Value
 end
 
+--[=[
+	Sets the transparency of the cusor
+
+	@param transparency number
+]=]
 function HSColorPickerCursor:SetTransparency(transparency)
 	assert(type(transparency) == "number", "Bad transparency")
 
@@ -143,4 +170,4 @@ function HSColorPickerCursor:_render()
 end
 
 
-return HSColorPickerCursor
+return HSColorPickerCursor

package/src/Client/HSV/HSColorPicker.lua

@@ -1,4 +1,7 @@
 --[=[
+	Picker for hue and Saturation in HSV. See [HSVColorPicker] for the full color picker,
+	which also allows you to select "Value".
+
 	@class HSColorPicker
 ]=]
 
@@ -6,9 +9,9 @@ local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
 local Blend = require("Blend")
+local ColorPickerCursorPreview = require("ColorPickerCursorPreview")
 local ColorPickerInput = require("ColorPickerInput")
 local HSColorPickerCursor = require("HSColorPickerCursor")
-local ColorPickerCursorPreview = require("ColorPickerCursorPreview")
 
 local HSColorPicker = setmetatable({}, BaseObject)
 HSColorPicker.ClassName = "HSColorPicker"
@@ -78,6 +81,11 @@ function HSColorPicker.new()
 	return self
 end
 
+--[=[
+	Gets whether the color picker is pressed or not.
+
+	@return BoolValue
+]=]
 function HSColorPicker:GetIsPressedValue()
 	return self._input:GetIsPressedValue()
 end
@@ -93,37 +101,70 @@ function HSColorPicker:_updateHintedColors()
 	self._preview:SetColor(hinted)
 end
 
+--[=[
+	Sets the HSVColor as a Vector3
+	@param hsvColor Vector3
+]=]
 function HSColorPicker:SetHSVColor(hsvColor)
 	assert(typeof(hsvColor) == "Vector3", "Bad hsvColor")
 
 	self._hsvColorValue.Value = hsvColor
 end
 
+--[=[
+	Gets the color as an HSV Vector3
+	@return Vector3
+]=]
 function HSColorPicker:GetHSVColor()
 	return self._hsvColorValue.Value
 end
 
+--[=[
+	Sets the color
+
+	@param color Color3
+]=]
 function HSColorPicker:SetColor(color)
 	local h, s, v = Color3.toHSV(color)
 	self._hsvColorValue.Value = Vector3.new(h, s, v)
 end
 
+--[=[
+	Gets the color
+
+	@return Color3
+]=]
 function HSColorPicker:GetColor()
 	local current = self._hsvColorValue.Value
 	local h, s, v = current.x, current.y, current.z
 	return Color3.fromHSV(h, s, v)
 end
 
+--[=[
+	Gets the size value for the HSColorPicker.
+
+	@return Vector3
+]=]
 function HSColorPicker:GetSizeValue()
 	return self._sizeValue
 end
 
+--[=[
+	Sets the transparency of the HSColorPicker
+
+	@param transparency number
+]=]
 function HSColorPicker:SetTransparency(transparency)
 	assert(type(transparency) == "number", "Bad transparency")
 
 	self._transparency.Value = transparency
 end
 
+--[=[
+	Sets the size of the color picker. This is in "line height" units.
+
+	@param height number
+]=]
 function HSColorPicker:SetSize(height)
 	assert(type(height) == "number", "Bad height")
 
@@ -162,4 +203,4 @@ function HSColorPicker:_render()
 	};
 end
 
-return HSColorPicker
+return HSColorPicker

package/src/Client/HSV/HSVColorPicker.lua

@@ -1,4 +1,7 @@
 --[=[
+	A HSV color picker component which can be used to select colors using
+	an interface standard to Roblox Studio.
+
 	@class HSVColorPicker
 ]=]
 
@@ -14,6 +17,17 @@ local HSVColorPicker = setmetatable({}, BaseObject)
 HSVColorPicker.ClassName = "HSVColorPicker"
 HSVColorPicker.__index = HSVColorPicker
 
+--[=[
+	Creates a new color picker!
+
+	```lua
+	local picker = HSVColorPicker.new()
+	picker:SetColor(Color3.new(0.5, 0.5, 0.5))
+	picker.Gui.Parent = screenGui
+	```
+
+	@return HSVColorPicker
+]=]
 function HSVColorPicker.new()
 	local self = setmetatable(BaseObject.new(), HSVColorPicker)
 
@@ -78,6 +92,12 @@ function HSVColorPicker.new()
 	return self
 end
 
+--[=[
+	Sets the height of the HSVColorPicker. This impacts the [GetSizeValue] return
+	size. This is a general interface to size things.
+
+	@param height number
+]=]
 function HSVColorPicker:SetSize(height)
 	assert(type(height) == "number", "Bad height")
 
@@ -85,6 +105,12 @@ function HSVColorPicker:SetSize(height)
 	self._valuePicker:SetSize(height)
 end
 
+--[=[
+	Syncs the color picker with the Color3Value.
+
+	@param color3Value Color3Value
+	@return maid
+]=]
 function HSVColorPicker:SyncValue(color3Value)
 	local maid = Maid.new()
 
@@ -108,35 +134,70 @@ function HSVColorPicker:SyncValue(color3Value)
 	return maid
 end
 
+--[=[
+	Hints what the background color of the HSVColorPicker. This impacts
+	some UI elements to ensure proper contrast.
+
+	@param color Color3
+]=]
 function HSVColorPicker:HintBackgroundColor(color)
 	self._valuePicker:HintBackgroundColor(color)
 end
 
+--[=[
+	Set the current color in HSV formet.
+
+	@param hsvColor Vector3
+]=]
 function HSVColorPicker:SetHSVColor(hsvColor)
 	assert(typeof(hsvColor) == "Vector3", "Bad hsvColor")
 
 	self._hsvColorValue.Value = hsvColor
 end
 
+--[=[
+	Get the current color in HSV formet as a Vector3.
+
+	@return Vector3
+]=]
 function HSVColorPicker:GetHSVColor()
 	return self._hsvColorValue.Value
 end
 
+--[=[
+	Set the current color.
+
+	@param color Color3
+]=]
 function HSVColorPicker:SetColor(color)
 	local h, s, v = Color3.toHSV(color)
 	self._hsvColorValue.Value = Vector3.new(h, s, v)
 end
 
+--[=[
+	Get the current color.
+
+	@return Color3
+]=]
 function HSVColorPicker:GetColor()
 	local current = self._hsvColorValue.Value
 	local h, s, v = current.x, current.y, current.z
 	return Color3.fromHSV(h, s, v)
 end
 
+--[=[
+	A size value that defines the aspect ratio and size of this picker. See [SetSize]
+	@return Vector3
+]=]
 function HSVColorPicker:GetSizeValue()
 	return self._sizeValue
 end
 
+--[=[
+	Sets the transparency of the color
+
+	@param transparency number
+]=]
 function HSVColorPicker:SetTransparency(transparency)
 	assert(type(transparency) == "number", "Bad transparency")
 
@@ -205,4 +266,4 @@ function HSVColorPicker:_render()
 	};
 end
 
-return HSVColorPicker
+return HSVColorPicker

package/src/Client/HSV/ValueColorPicker.lua

@@ -1,4 +1,5 @@
 --[=[
+	Picker for value in HSV. See [HSVColorPicker]
 	@class ValueColorPicker
 ]=]
 
@@ -250,4 +251,4 @@ function ValueColorPicker:_render()
 	};
 end
 
-return ValueColorPicker
+return ValueColorPicker