ComponentRenderer used on all components

Author: BlazOrazem

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2025-03-20
+### Changes
+- Usage of the `ComponentRenderer` trait on all components
+- Composer requires `NumenCode.Fundamentals` version 1.1 or higher
+
 ## [1.1.0] - 2025-03-06
 ### Added
 - Gallery - manage multiple image galleries

README.md

@@ -35,7 +35,7 @@ php artisan winter:up
 
 ## Requirements
 
-* [NumenCode Fundamentals Plugin](https://github.com/numencode/wn-fundamentals-plugin) version ^1.0 or higher.
+* [NumenCode Fundamentals Plugin](https://github.com/numencode/wn-fundamentals-plugin) version ^1.1 or higher.
 * [Winter CMS](https://wintercms.com/) 1.2.7 or higher.
 * PHP version 8.0 or higher.
 
@@ -47,6 +47,22 @@ This plugin provides an intuitive interface to create and manage a variety of wi
 to customize their websites with ease. With multilingual support via the `Winter.Translate` plugin,
 it ensures global usability.
 
+### Component Rendering System
+
+All widget components in this plugin leverage the `ComponentRenderer` trait from the **NumenCode.Fundamentals** plugin.
+This provides several key benefits:
+
+- **Automatic Alias Resolution**: Each component’s alias is automatically set based on its class name.
+- **Customizable Rendering**: Users can override default component templates via theme partials.
+- **Layout Selection**: Components support multiple layout options, allowing greater flexibility in presentation.
+
+To override a component’s layout, create a folder inside your theme's partials directory matching the component's alias
+(e.g., `/themes/custom/partials/mycomponent`) and add layout files like `default.htm`, `special.htm`, etc.
+
+---
+
+## Available Widgets
+
 ### Counters
 
 Showcase statistics or numeric information on your website using dynamic and engaging animated counters.

components/Counters.php

@@ -1,9 +1,12 @@
 <?php namespace NumenCode\Widgets\Components;
 
 use Cms\Classes\ComponentBase;
+use NumenCode\Fundamentals\Traits\ComponentRenderer;
 
 class Counters extends ComponentBase
 {
+    use ComponentRenderer;
+
     public $counters;
 
     public function componentDetails(): array

components/Features.php

@@ -2,9 +2,12 @@
 
 use Cms\Classes\ComponentBase;
 use NumenCode\Widgets\Models\FeatureGroup;
+use NumenCode\Fundamentals\Traits\ComponentRenderer;
 
 class Features extends ComponentBase
 {
+    use ComponentRenderer;
+
     public $group;
 
     public function componentDetails(): array
@@ -38,28 +41,11 @@ public function onRun()
         $this->group = $this->loadGroup();
     }
 
-    public function onRender()
-    {
-        if (!$layout = $this->property('layout')) {
-            $layout = 'default';
-        }
-
-        return $this->renderPartial('@' . $layout . '.htm');
-    }
-
     public function getTitleOptions(): array
     {
         return FeatureGroup::lists('title', 'id');
     }
 
-    public function getLayoutOptions(): array
-    {
-        return [
-            'default' => 'Default',
-            'media'   => 'Default with pictures',
-        ];
-    }
-
     protected function loadGroup()
     {
         return FeatureGroup::find($this->property('title'));

components/Gallery.php

@@ -2,9 +2,12 @@
 
 use Cms\Classes\ComponentBase;
 use NumenCode\Widgets\Models\GalleryGroup;
+use NumenCode\Fundamentals\Traits\ComponentRenderer;
 
 class Gallery extends ComponentBase
 {
+    use ComponentRenderer;
+
     public $gallery;
     public $itemsPerRow;
 
@@ -47,27 +50,11 @@ public function onRun()
         $this->itemsPerRow = $this->property('items_per_row') ?? 4;
     }
 
-    public function onRender()
-    {
-        if (!$layout = $this->property('layout')) {
-            $layout = 'default';
-        }
-
-        return $this->renderPartial('@' . $layout . '.htm');
-    }
-
     public function getTitleOptions(): array
     {
         return GalleryGroup::lists('title', 'id');
     }
 
-    public function getLayoutOptions(): array
-    {
-        return [
-            'default' => 'Default',
-        ];
-    }
-
     protected function loadGallery()
     {
         return GalleryGroup::find($this->property('title'));

components/Highlights.php

@@ -2,9 +2,12 @@
 
 use Cms\Classes\ComponentBase;
 use NumenCode\Widgets\Models\HighlightGroup;
+use NumenCode\Fundamentals\Traits\ComponentRenderer;
 
 class Highlights extends ComponentBase
 {
+    use ComponentRenderer;
+
     public $group;
 
     public function componentDetails(): array
@@ -38,27 +41,11 @@ public function onRun()
         $this->group = $this->loadGroup();
     }
 
-    public function onRender()
-    {
-        if (!$layout = $this->property('layout')) {
-            $layout = 'default';
-        }
-
-        return $this->renderPartial('@' . $layout . '.htm');
-    }
-
     public function getTitleOptions(): array
     {
         return HighlightGroup::lists('title', 'id');
     }
 
-    public function getLayoutOptions(): array
-    {
-        return [
-            'default' => 'Default',
-        ];
-    }
-
     protected function loadGroup()
     {
         return HighlightGroup::find($this->property('title'));

components/Promotions.php

@@ -2,9 +2,12 @@
 
 use Cms\Classes\ComponentBase;
 use NumenCode\Widgets\Models\PromotionGroup;
+use NumenCode\Fundamentals\Traits\ComponentRenderer;
 
 class Promotions extends ComponentBase
 {
+    use ComponentRenderer;
+
     public $group;
 
     public function componentDetails(): array
@@ -38,27 +41,11 @@ public function onRun()
         $this->group = $this->loadGroup();
     }
 
-    public function onRender()
-    {
-        if (!$layout = $this->property('layout')) {
-            $layout = 'default';
-        }
-
-        return $this->renderPartial('@' . $layout . '.htm');
-    }
-
     public function getTitleOptions(): array
     {
         return PromotionGroup::lists('title', 'id');
     }
 
-    public function getLayoutOptions(): array
-    {
-        return [
-            'default' => 'Bootstrap 4',
-        ];
-    }
-
     protected function loadGroup()
     {
         return PromotionGroup::find($this->property('title'));

components/features/media.htm …mponents/features/default_with_media.htmcomponents/features/media.htm renamed to components/features/default_with_media.htm components/features/media.htm renamed to components/features/default_with_media.htm

@@ -19,7 +19,7 @@
     ],
     "require": {
         "php": "^8.0.2",
-        "numencode/wn-fundamentals-plugin": "^1.0"
+        "numencode/wn-fundamentals-plugin": "^1.1"
     },
     "extra": {
         "installer-name": "widgets"