Merge pull request #24110 from abpframework/EngincanV/cmskit-dynamicwidget

CMS Kit: Add commenting widget as content widget

docs/en/modules/cms-kit/dynamic-widget.md

@@ -124,21 +124,26 @@ In this image, after choosing your widget (on the other case, it changes automat
 
 You can edit this output manually if do any wrong coding for that (wrong value or typo) you won't see the widget, even so, your page will be viewed successfully. 
 
-## Options 
-To configure the widget, you should define the below code in YourModule.cs 
+## Options
+
+To add content widgets, you should configure the `CmsKitContentWidgetOptions` in your module's `ConfigureServices` method:
 
 ```csharp
 Configure<CmsKitContentWidgetOptions>(options =>
     {
         options.AddWidget(widgetType: "Today", widgetName: "CmsToday", parameterWidgetName: "Format");
+
+        // Alternatively, you can add a widget conditionally based on a global feature being enabled
+        options.AddWidgetIfFeatureEnabled(typeof(PagesFeature), "Today", "CmsToday", "Format");
     }); 
 ```
 
-Let's look at these parameters in detail
-* `widgetType` is used for end-user and more readable names. The following bold word represents widgetType.
-[Widget Type="**Today**" Format="yyyy-dd-mm HH:mm:ss"].
+The `CmsKitContentWidgetOptions` provides two methods for registering widgets:
 
-* `widgetName` is used for your widget name used in code for the name of the `ViewComponent`.
+- **AddWidget:** Registers a widget that will be available in the content editor. It accepts the following parameters:
+    - `widgetType` (required): A user-friendly name for the widget that appears in the widget selection dropdown and is used in content markup. For example, in `[Widget Type="Today"]`, `"Today"` is the `widgetType`.
+    - `widgetName` (required): The name of the `ViewComponent` that will be rendered. This must match the `Name` attribute of your `ViewComponent` (e.g., `[ViewComponent(Name = "CmsToday")]`).
+    - `parameterWidgetName` (optional): The name of the parameter widget that will be displayed in the "Add Widget" modal to collect parameter values from users. This is only required when your widget needs parameters.
 
-* `parameterWidgetName` is used the for editor component side to see on the `Add Widget` modal.
-After choosing the widget type from listbox (now just defined `Format`) and renders this widget automatically. It's required only to see UI once using parameters
+- **AddWidgetIfFeatureEnabled:** Registers a widget conditionally, only if a specified [global feature](../../framework/infrastructure/global-features.md) is enabled. It accepts the same parameters as `AddWidget`, plus an additional first parameter:
+    - `featureType` (required): The type of the global feature that must be enabled for the widget to be available (e.g., `typeof(PagesFeature)`).

modules/cms-kit/src/Volo.CmsKit.Admin.Web/Pages/CmsKit/Contents/addWidgetModal.js

@@ -31,7 +31,14 @@ $(function () {
 
                 for (var propertyName in properties) {
                     if (!propertyName.includes(']') && !propertyName.includes('[')) {
-                        widgetText += propertyName + "=\"" + properties[propertyName] + "\" ";
+                        var propertyValue = properties[propertyName];
+                        
+                        //skip default/empty values
+                        if (propertyValue === null || propertyValue === undefined || propertyValue === '') {
+                            continue;
+                        }
+
+                        widgetText += propertyName + "=\"" + propertyValue + "\" ";
                     }
                 }
 

modules/cms-kit/src/Volo.CmsKit.Common.Web/CmsKitCommonWebModule.cs

@@ -7,6 +7,8 @@ using Volo.CmsKit.Reactions;
 using Volo.CmsKit.Web.Icons;
 using Markdig;
 using Microsoft.Extensions.DependencyInjection;
+using Volo.CmsKit.GlobalFeatures;
+using Volo.CmsKit.Web.Contents;
 
 namespace Volo.CmsKit.Web;
 
@@ -54,6 +56,11 @@ public class CmsKitCommonWebModule : AbpModule
         {
             options.DisableModule(CmsKitCommonRemoteServiceConsts.ModuleName);
         });
+
+        Configure<CmsKitContentWidgetOptions>(options =>
+        {
+            options.AddWidgetIfFeatureEnabled(typeof(CommentsFeature), "Comment", "CmsCommenting", "CmsKitCommentConfiguration");
+        });
     }
 }
 

modules/cms-kit/src/Volo.CmsKit.Common.Web/Pages/CmsKit/Components/Comments/CmsKitCommentConfiguration.cshtml

@@ -0,0 +1,11 @@
+@using Microsoft.Extensions.Localization
+@using Volo.CmsKit.Localization
+@using Volo.CmsKit.Web.Pages.CmsKit.Components.Comments
+@inject IStringLocalizer<CmsKitResource> L
+@model CmsKitCommentConfigurationViewModel
+
+<div>
+    <abp-input asp-for="EntityType" label="@L["EntityType"]" />
+    <abp-input asp-for="EntityId" label="@L["EntityId"]" />
+    <abp-input asp-for="IsReadOnly" label="@L["IsReadOnly"]" />
+</div>

modules/cms-kit/src/Volo.CmsKit.Common.Web/Pages/CmsKit/Components/Comments/CmsKitCommentConfigurationViewComponent.cs

@@ -0,0 +1,15 @@
+using Microsoft.AspNetCore.Mvc;
+using Volo.Abp.AspNetCore.Mvc;
+using Volo.Abp.AspNetCore.Mvc.UI.Widgets;
+
+namespace Volo.CmsKit.Web.Pages.CmsKit.Components.Comments;
+
+[Widget]
+[ViewComponent(Name = "CmsKitCommentConfiguration")]
+public class CmsKitCommentConfigurationViewComponent : AbpViewComponent
+{
+    public IViewComponentResult Invoke()
+    {
+        return View("~/Pages/CmsKit/Components/Comments/CmsKitCommentConfiguration.cshtml", new CmsKitCommentConfigurationViewModel());
+    }
+}

modules/cms-kit/src/Volo.CmsKit.Common.Web/Pages/CmsKit/Components/Comments/CmsKitCommentConfigurationViewModel.cs

@@ -0,0 +1,14 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace Volo.CmsKit.Web.Pages.CmsKit.Components.Comments;
+
+public class CmsKitCommentConfigurationViewModel
+{
+  [Required]
+  public string EntityType { get; set; }
+
+  [Required]
+  public string EntityId { get; set; }
+
+  public bool IsReadOnly { get; set; } = false;
+}

modules/cms-kit/src/Volo.CmsKit.Common.Web/Pages/CmsKit/Components/Contents/CmsKitContentWidgetOptions.cs

@@ -1,4 +1,8 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
+using System.Reflection;
+using Volo.Abp;
+using Volo.Abp.GlobalFeatures;
 
 namespace Volo.CmsKit.Web.Contents;
 
@@ -16,4 +20,21 @@ public class CmsKitContentWidgetOptions
         var config = new ContentWidgetConfig(widgetName, parameterWidgetName);
         WidgetConfigs.Add(widgetType, config);
     }
+
+    public void AddWidgetIfFeatureEnabled(Type globalFeatureType, string widgetType, string widgetName, string parameterWidgetName = null)
+    {
+        Check.NotNull(globalFeatureType, nameof(globalFeatureType));
+
+        if (globalFeatureType.GetCustomAttribute<GlobalFeatureNameAttribute>() == null)
+        {
+            throw new ArgumentException($"The type {globalFeatureType.Name} must have a {nameof(GlobalFeatureNameAttribute)} attribute.", nameof(globalFeatureType));
+        }
+
+        if (!GlobalFeatureManager.Instance.IsEnabled(globalFeatureType))
+        {
+            return;
+        }
+
+        AddWidget(widgetType, widgetName, parameterWidgetName);
+    }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/ar.json

@@ -262,6 +262,7 @@
     "SelectAnBlogToAssign": "حدد مدونة لتعيين مشاركات المدونة إليها",
     "DeleteAllBlogPostsOfThisBlog": "حذف جميع مشاركات المدونة",
     "RequiredPermissionName": "اسم الإذن المطلوب",
-    "AllPosts": "جميع المشاركات"
+    "AllPosts": "جميع المشاركات",
+    "IsReadOnly": "للقراءة فقط"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/cs.json

@@ -281,6 +281,7 @@
     "SelectAnBlogToAssign": "Vyberte blog, ke kterému chcete přiřadit blogové příspěvky",
     "DeleteAllBlogPostsOfThisBlog": "Smazat všechny blogové příspěvky tohoto blogu",
     "RequiredPermissionName": "Je vyžadováno oprávnění",
-    "AllPosts": "Všechny příspěvky"
+    "AllPosts": "Všechny příspěvky",
+    "IsReadOnly": "Pouze pro čtení"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/de-DE.json

@@ -169,6 +169,7 @@
     "SelectAnBlogToAssign": "Wählen Sie einen Blog aus, um Blogbeiträge zuzuweisen",
     "DeleteAllBlogPostsOfThisBlog": "Alle Blogbeiträge dieses Blogs löschen",
     "RequiredPermissionName": "Erforderlicher Berechtigungsname",
-    "AllPosts": "Alle Beiträge"
+    "AllPosts": "Alle Beiträge",
+    "IsReadOnly": "Schreibgeschützt"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/de.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Wählen Sie einen Blog aus, um Blogbeiträge zuzuweisen",
     "DeleteAllBlogPostsOfThisBlog": "Alle Blogbeiträge dieses Blogs löschen",
     "RequiredPermissionName": "Erforderlicher Berechtigungsname",
-    "AllPosts": "Alle Beiträge"
+    "AllPosts": "Alle Beiträge",
+    "IsReadOnly": "Schreibgeschützt"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/el.json

@@ -192,6 +192,7 @@
     "SelectAnBlogToAssign": "Επιλέξτε ένα ιστολόγιο για να αναθέσετε αναρτήσεις ιστολογίου",
     "DeleteAllBlogPostsOfThisBlog": "Διαγραφή όλων των αναρτήσεων ιστολογίου αυτού του ιστολογίου",
     "RequiredPermissionName": "Απαιτούμενο όνομα δικαιώματος",
-    "AllPosts": "Όλες οι δημοσιεύσεις"
+    "AllPosts": "Όλες οι δημοσιεύσεις",
+    "IsReadOnly": "Μόνο για ανάγνωση"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/en-GB.json

@@ -34,6 +34,7 @@
     "SelectAnBlogToAssign": "Select a blog to assign",
     "DeleteAllBlogPostsOfThisBlog": "Delete all blog posts of this blog",
     "RequiredPermissionName": "Required permission name",
-    "AllPosts": "All posts"
+    "AllPosts": "All posts",
+    "IsReadOnly": "Readonly"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/en.json

@@ -280,6 +280,7 @@
     "SelectAnBlogToAssign": "Select a blog to assign",
     "DeleteAllBlogPostsOfThisBlog": "Delete all blog posts of this blog",
     "RequiredPermissionName": "Required permission name",
-    "AllPosts": "All posts"
+    "AllPosts": "All posts",
+    "IsReadOnly": "Readonly"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/es.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Seleccione un blog para asignar publicaciones de blog",
     "DeleteAllBlogPostsOfThisBlog": "Eliminar todas las publicaciones de blog de este blog",
     "RequiredPermissionName": "Nombre de permiso requerido",
-    "AllPosts": "Todas las publicaciones"
+    "AllPosts": "Todas las publicaciones",
+    "IsReadOnly": "Solo lectura"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/fa.json

@@ -191,6 +191,7 @@
     "SelectAnBlogToAssign": "یک وبلاگ برای اختصاص دادن انتخاب کنید",
     "DeleteAllBlogPostsOfThisBlog": "تمام پست های وبلاگ این وبلاگ را حذف کنید",
     "RequiredPermissionName": "نام مجوز مورد نیاز",
-    "AllPosts": "همه پست ها"
+    "AllPosts": "همه پست ها",
+    "IsReadOnly": "فقط خواندنی"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/fi.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Valitse blogi, johon haluat määrittää",
     "DeleteAllBlogPostsOfThisBlog": "Poista tämän blogin kaikki blogiviestit",
     "RequiredPermissionName": "Tarvittava lupa",
-    "AllPosts": "Kaikki viestit"
+    "AllPosts": "Kaikki viestit",
+    "IsReadOnly": "Vain luku"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/fr.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Sélectionnez un blog à attribuer",
     "DeleteAllBlogPostsOfThisBlog": "Supprimer tous les articles de blog de ce blog",
     "RequiredPermissionName": "Nom de permission requis",
-    "AllPosts": "Tous les messages"
+    "AllPosts": "Tous les messages",
+    "IsReadOnly": "Lecture seule"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/hi.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "असाइन करने के लिए एक ब्लॉग चुनें",
     "DeleteAllBlogPostsOfThisBlog": "इस ब्लॉग के सभी ब्लॉग पोस्ट हटाएं",
     "RequiredPermissionName": "आवश्यक अनुमति नाम",
-    "AllPosts": "सभी पोस्ट"
+    "AllPosts": "सभी पोस्ट",
+    "IsReadOnly": "केवल पढ़ने के लिए"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/hr.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Odaberite blog za dodjelu",
     "DeleteAllBlogPostsOfThisBlog": "Izbrišite sve postove na blogu",
     "RequiredPermissionName": "Potrebno ime dozvole",
-    "AllPosts": "Sve objave"
+    "AllPosts": "Sve objave",
+    "IsReadOnly": "Samo za čitanje"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/hu.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Válasszon egy blogot a hozzárendeléshez",
     "DeleteAllBlogPostsOfThisBlog": "Ez a művelet törli az összes blogbejegyzést ebből a blogból. Biztos vagy benne?",
     "RequiredPermissionName": "Szükséges engedély neve",
-    "AllPosts": "Minden bejegyzés"
+    "AllPosts": "Minden bejegyzés",
+    "IsReadOnly": "Csak olvasható"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/is.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Veldu blogg til að úthluta",
     "DeleteAllBlogPostsOfThisBlog": "Eyða öllum bloggfærslum þessa bloggs",
     "RequiredPermissionName": "Nafn á nauðsynlegri leyfi",
-    "AllPosts": "Allar færslur"
+    "AllPosts": "Allar færslur",
+    "IsReadOnly": "Skrifvarið"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/it.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Seleziona un blog a cui assegnare i post del blog",
     "DeleteAllBlogPostsOfThisBlog": "Elimina tutti i post del blog di questo blog",
     "RequiredPermissionName": "Nome del permesso richiesto",
-    "AllPosts": "Tutti i post"
+    "AllPosts": "Tutti i post",
+    "IsReadOnly": "Sola lettura"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/nl.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Selecteer een blog om toe te wijzen",
     "DeleteAllBlogPostsOfThisBlog": "Verwijder alle blogberichten van deze blog",
     "RequiredPermissionName": "Vereiste toestemming",
-    "AllPosts": "Alle berichten"
+    "AllPosts": "Alle berichten",
+    "IsReadOnly": "Alleen-lezen"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/pl-PL.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Wybierz blog, do którego chcesz przypisać posty na blogu",
     "DeleteAllBlogPostsOfThisBlog": "Usuń wszystkie posty na blogu tego bloga",
     "RequiredPermissionName": "Wymagana nazwa uprawnienia",
-    "AllPosts": "Wszystkie posty"
+    "AllPosts": "Wszystkie posty",
+    "IsReadOnly": "Tylko do odczytu"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/pt-BR.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Selecione um blog para atribuir",
     "DeleteAllBlogPostsOfThisBlog": "Excluir todas as postagens de blog deste blog",
     "RequiredPermissionName": "Nome da permissão necessária",
-    "AllPosts": "Todas as postagens"
+    "AllPosts": "Todas as postagens",
+    "IsReadOnly": "Somente leitura"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/ro-RO.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Selectaţi un blog pentru a atribui postările de blog",
     "DeleteAllBlogPostsOfThisBlog": "Ştergeţi toate postările de blog ale acestui blog",
     "RequiredPermissionName": "Numele permisiunii necesare",
-    "AllPosts": "Toate postările"
+    "AllPosts": "Toate postările",
+    "IsReadOnly": "Doar citire"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/ru.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Выберите блог для назначения",
     "DeleteAllBlogPostsOfThisBlog": "Удалить все сообщения в блоге этого блога",
     "RequiredPermissionName": "Имя требуемого разрешения",
-    "AllPosts": "Все записи"
+    "AllPosts": "Все записи",
+    "IsReadOnly": "Только для чтения"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/sk.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Vyberte blog, na ktorý chcete priradiť blogové príspevky",
     "DeleteAllBlogPostsOfThisBlog": "Zmazať všetky blogové príspevky tohto blogu",
     "RequiredPermissionName": "Požadovaný názov oprávnenia",
-    "AllPosts": "Všetky príspevky"
+    "AllPosts": "Všetky príspevky",
+    "IsReadOnly": "Iba na čítanie"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/sl.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Izberite blog, ki mu želite dodeliti objave",
     "DeleteAllBlogPostsOfThisBlog": "Izbriši vse objave v tem blogu",
     "RequiredPermissionName": "Ime zahtevane dovoljenja",
-    "AllPosts": "Vse objave"
+    "AllPosts": "Vse objave",
+    "IsReadOnly": "Samo za branje"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/sv.json

@@ -262,6 +262,7 @@
     "SelectAnBlogToAssign": "Välj en blogg att tilldela",
     "DeleteAllBlogPostsOfThisBlog": "Radera alla blogginlägg i denna blogg",
     "RequiredPermissionName": "Nödvändigt behörighetsnamn",
-    "AllPosts": "Alla inlägg"
+    "AllPosts": "Alla inlägg",
+    "IsReadOnly": "Skrivskyddad"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/tr.json

@@ -226,6 +226,7 @@
     "SelectAnBlogToAssign": "Atanacak bir blog seçin",
     "DeleteAllBlogPostsOfThisBlog": "Bu blogun tüm blog yazılarını sil",
     "RequiredPermissionName": "Gerekli izin adı",
-    "AllPosts": "Tüm gönderiler"
+    "AllPosts": "Tüm gönderiler",
+    "IsReadOnly": "Salt okunur"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/vi.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "Chọn một blog để gán",
     "DeleteAllBlogPostsOfThisBlog": "Xóa tất cả bài đăng trên blog của blog này",
     "RequiredPermissionName": "Tên quyền cần thiết",
-    "AllPosts": "Tất cả bài viết"
+    "AllPosts": "Tất cả bài viết",
+    "IsReadOnly": "Chỉ đọc"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/zh-Hans.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "选择要分配的博客",
     "DeleteAllBlogPostsOfThisBlog": "删除此博客的所有博客文章",
     "RequiredPermissionName": "所需权限名称",
-    "AllPosts": "所有帖子"
+    "AllPosts": "所有帖子",
+    "IsReadOnly": "只读"
   }
 }

modules/cms-kit/src/Volo.CmsKit.Domain.Shared/Volo/CmsKit/Localization/Resources/zh-Hant.json

@@ -235,6 +235,7 @@
     "SelectAnBlogToAssign": "選擇要分配的部落格",
     "DeleteAllBlogPostsOfThisBlog": "刪除此部落格的所有部落格文章",
     "RequiredPermissionName": "所需權限名稱",
-    "AllPosts": "所有文章"
+    "AllPosts": "所有文章",
+    "IsReadOnly": "唯讀"
   }
 }