Deprecate the viewMode preset setting. Bump to 2.3.0

vaersaagod · Apr 13, 2024 · 1941267 · 1941267
1 parent f226de3
commit 1941267
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # ColorMate Changelog
 
+## 2.3.0 - 2024-04-13
+### Changed
+- Deprecated the `viewMode` config setting for presets  
+
 ## 2.2.3.1 - 2024-04-02
 ### Fixed
 - Add that min-height back in 🙃

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "vaersaagod/colormate",
   "description": "Color me impressed, mate!",
-  "version": "2.2.3.1",
+  "version": "2.3.0",
   "type": "craft-plugin",
   "keywords": [
     "craft",

diff --git a/src/fields/ColorMateField.php b/src/fields/ColorMateField.php
@@ -39,10 +39,16 @@
 class ColorMateField extends Field implements PreviewableFieldInterface
 {
 
-    /** @var string */
+    /**
+     * @var string
+     * @deprecated Since 2.3.0
+     */
     public const FIELD_VIEW_MODE_COMPACT = 'compact';
 
-    /** @var string */
+    /**
+     * @var string
+     * @deprecated Since 2.3.0
+     */
     public const FIELD_VIEW_MODE_EXPANDED = 'expanded';
 
     /** @var string */

diff --git a/src/models/Preset.php b/src/models/Preset.php
@@ -10,7 +10,9 @@
 
 namespace vaersaagod\colormate\models;
 
+use Craft;
 use craft\base\Model;
+
 use vaersaagod\colormate\fields\ColorMateField;
 
 /**
@@ -32,6 +34,7 @@ class Preset extends Model
 
     /**
      * @var string
+     * @deprecated Since 2.3.0
      */
     public string $viewMode = ColorMateField::FIELD_VIEW_MODE_COMPACT;
 
@@ -64,7 +67,15 @@ class Preset extends Model
      * @var string|null
      */
     public ?string $default = null;
-
+
+    /** @inheritdoc */
+    public function init(): void
+    {
+        parent::init();
+        if (!empty($this->viewMode)) {
+            Craft::$app->getDeprecator()->log(__METHOD__, "The `viewMode` preset config setting is deprecated. You should remove references to it from your `colormate.php` config file.");
+        }
+    }
 
     /**
      * @return PresetColor[]