ABS4: Summernote is now the primary HTML editor

smartstore · Feb 24, 2018 · 31c83c6 · 31c83c6
1 parent b2ac077
commit 31c83c6
Show file tree

Hide file tree

Showing 24 changed files with 300 additions and 227 deletions.
diff --git a/CREDITS.txt b/CREDITS.txt
@@ -52,11 +52,11 @@ Copyright:    Copyright Andrey Taritsyn 2014
 License:      Apache License 2.0 (Apache)
 
 
-CKEditor
+summernote
 ---------------------------------------------
-WebSite:      http://ckeditor.com/
-Copyright:    &copy 2014 CKSource - Frederico Knabben
-License:      GNU Library General Public License (LGPL)
+WebSite:      https://summernote.org/
+Copyright:    Copyright (c) 2015~ Summernote Team (https://github.com/orgs/summernote/people)
+License:      MIT
 
 
 DotNetOpenAuth

diff --git a/changelog.md b/changelog.md
@@ -1,4 +1,4 @@
-# Release Notes
+# Release Notes
 
 ## SmartStore.NET 3.1.0
 ### Breaking changes
@@ -22,6 +22,7 @@
 
 ### New Features
 * 1203 MegaMenu shrinker and *Brands* virtual menu item
+* [Summernote](https://summernote.org/) is now the primary HTML editor
 * #431 Added option to randomize the display order for slides on each request
 * #1258 Add option to filter shipping and payment methods by a specific customer role
 * #1247 Allow to import non system customer roles in customer import

diff --git a/src/Libraries/SmartStore.Core/Domain/Common/AdminAreaSettings.cs b/src/Libraries/SmartStore.Core/Domain/Common/AdminAreaSettings.cs
@@ -9,13 +9,10 @@ public AdminAreaSettings()
 		{
 			GridPageSize = 25;
 			DisplayProductPictures = true;
-			RichEditorFlavor = "RichEditor";
 		}
 
 		public int GridPageSize { get; set; }
 
         public bool DisplayProductPictures { get; set; }
-
-        public string RichEditorFlavor { get; set; }
     }
 }
diff --git a/src/Presentation/SmartStore.Web.Framework/UI/Extensions/ScaffoldExtensions.cs b/src/Presentation/SmartStore.Web.Framework/UI/Extensions/ScaffoldExtensions.cs
@@ -1,4 +1,5 @@
-using System.Text;
+using System;
+using System.Text;
 using System.Web.Mvc;
 using System.Web.WebPages;
 using SmartStore.Core.Domain.Common;
@@ -96,9 +97,10 @@ public static HelperResult LabeledCurrencyName<T>(this HtmlHelper<T> helper, int
 			return new HelperResult(writer => writer.Write(sb.ToString()));
 		}
 
+		[Obsolete]
         public static string RichEditorFlavor(this HtmlHelper helper)
         {
-            return EngineContext.Current.Resolve<AdminAreaSettings>().RichEditorFlavor.NullEmpty() ?? "RichEditor";
+            return "Html";
         }
 
         public static GridEditActionCommandBuilder Localize(this GridEditActionCommandBuilder builder, Localizer T)

diff --git a/src/Presentation/SmartStore.Web/Administration/Content/_admin.scss b/src/Presentation/SmartStore.Web/Administration/Content/_admin.scss
@@ -1363,6 +1363,21 @@ table.payment-method-features td {
     box-shadow: none;
 }
 
+.note-editor-preview {
+	border: 1px solid $input-border-color;
+	min-height: 100px;
+	max-height: 350px;
+	overflow-x: hidden;
+	overflow-y: auto;
+	padding: $input-padding-y $input-padding-x;
+	cursor: default;
+
+	&.empty {
+		min-height: initial;
+		//color: $text-muted;
+	}
+}
+
 .note-editor {
 	border-color: $input-border-color !important;
 	border-radius: $input-border-radius !important;
@@ -1400,7 +1415,20 @@ table.payment-method-features td {
 		}
 
 		.note-para > .btn-group:last-child .dropdown-menu.show {
+			// Fix: the para popover button groups should not wrap
 			display: flex !important;
 		}
+
+		.dropdown-style > .dropdown-item > * {
+			// Fix: Summernote does not remove the BS4 bottom margin of para style dropdown items
+			margin-bottom: 0;
+		}
+
+		.note-color + .btn-group > .btn {
+			// Fix: the fontsize button width should not change (toolbar flickers)
+			padding-left: 0.5rem;
+			padding-right: 0.5rem;
+			min-width: 50px;
+		}
 	}
 }
diff --git a/src/Presentation/SmartStore.Web/Administration/SmartStore.Admin.csproj b/src/Presentation/SmartStore.Web/Administration/SmartStore.Admin.csproj
@@ -1505,7 +1505,7 @@
     <Content Include="Views\Common\GenericAttributes.cshtml" />
   </ItemGroup>
   <ItemGroup>
-    <Content Include="Views\Shared\EditorTemplates\RichEditor.SummerNote.cshtml" />
+    <Content Include="Views\Shared\EditorTemplates\Html.cshtml" />
   </ItemGroup>
   <ItemGroup>
     <Content Include="Views\Product\EditorTemplates\AttributeControlType.cshtml" />

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Blog/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Blog/_CreateOrUpdate.cshtml
@@ -44,7 +44,7 @@
                 @Html.SmartLabelFor(model => model.Body)
             </td>
             <td class="adminData wide">
-                @Html.EditorFor(x => x.Body, Html.RichEditorFlavor())
+                @Html.EditorFor(x => x.Body, "Html")
                 @Html.ValidationMessageFor(model => model.Body)
             </td>
         </tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Campaign/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Campaign/_CreateOrUpdate.cshtml
@@ -53,7 +53,7 @@
 				@Html.SmartLabelFor(model => model.Body)
 			</td>
 			<td class="adminData wide">
-				@Html.EditorFor(model => model.Body, "RichEditor")
+				@Html.EditorFor(model => model.Body, "Html", new { lazy = false })
 				@Html.ValidationMessageFor(model => model.Body)
 			</td>
 		</tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Category/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Category/_CreateOrUpdate.cshtml
@@ -63,7 +63,7 @@
                     @Html.SmartLabelFor(model => model.Locales[item].Description)
                 </td>
                 <td class="adminData wide">
-                    @Html.EditorFor(model => model.Locales[item].Description, Html.RichEditorFlavor())
+                    @Html.EditorFor(model => model.Locales[item].Description, "Html")
                     @Html.ValidationMessageFor(model => model.Locales[item].Description)
                 </td>
             </tr>
@@ -72,7 +72,7 @@
                     @Html.SmartLabelFor(model => model.Locales[item].BottomDescription)
                 </td>
                 <td class="adminData wide">
-                    @Html.EditorFor(model => model.Locales[item].BottomDescription, Html.RichEditorFlavor())
+                    @Html.EditorFor(model => model.Locales[item].BottomDescription, "Html")
                     @Html.ValidationMessageFor(model => model.Locales[item].BottomDescription)
                 </td>
             </tr>
@@ -121,7 +121,7 @@
                     @Html.SmartLabelFor(model => model.Description)
                 </td>
                 <td class="adminData wide">
-                    @Html.EditorFor(x => x.Description, Html.RichEditorFlavor())
+                    @Html.EditorFor(x => x.Description, "Html")
                     @Html.ValidationMessageFor(model => model.Description)
                 </td>
             </tr>
@@ -130,7 +130,7 @@
                     @Html.SmartLabelFor(model => model.BottomDescription)
                 </td>
                 <td class="adminData wide">
-                    @Html.EditorFor(x => x.BottomDescription, Html.RichEditorFlavor())
+                    @Html.EditorFor(x => x.BottomDescription, "Html")
                     @Html.ValidationMessageFor(model => model.BottomDescription)
                 </td>
             </tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Home/About.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Home/About.cshtml
@@ -82,12 +82,12 @@
 			</li>
 			<li>
 				<div class="name">
-					<a href="http://ckeditor.com/" rel="nofollow" target="AboutTargetWin">CKEditor</a>
+					<a href="https://summernote.org/" rel="nofollow" target="AboutTargetWin">summernote</a>
 				</div>
 				<div class="copyright">
-					&copy 2018 CKSource - Frederico Knabben
+					&copy 2015~ Summernote Team (https://github.com/orgs/summernote/people)
 				</div>
-				@LGPLLicense()
+				@MITLicense()
 			</li>
 			<li>
 				<div class="name">

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Manufacturer/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Manufacturer/_CreateOrUpdate.cshtml
@@ -51,7 +51,7 @@
                     @Html.SmartLabelFor(model => model.Locales[item].Description)
                 </td>
                 <td class="adminData wide">
-                    @Html.EditorFor(model => model.Locales[item].Description, Html.RichEditorFlavor())
+                    @Html.EditorFor(model => model.Locales[item].Description, "Html")
                     @Html.ValidationMessageFor(model => model.Locales[item].Description)
                 </td>
             </tr>
@@ -72,7 +72,7 @@
                     @Html.SmartLabelFor(model => model.Description)
                 </td>
                 <td class="adminData wide">
-                    @Html.EditorFor(x => x.Description, Html.RichEditorFlavor())
+                    @Html.EditorFor(x => x.Description, "Html")
                     @Html.ValidationMessageFor(model => model.Description)
                 </td>
             </tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/News/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/News/_CreateOrUpdate.cshtml
@@ -50,7 +50,7 @@
                 @Html.SmartLabelFor(model => model.Full)
             </td>
             <td class="adminData wide">
-                @Html.EditorFor(x => x.Full, Html.RichEditorFlavor())
+                @Html.EditorFor(x => x.Full, "Html")
                 @Html.ValidationMessageFor(model => model.Full)
             </td>
         </tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Payment/Edit.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Payment/Edit.cshtml
@@ -71,7 +71,7 @@
 				@Html.SmartLabelFor(model => model.Locales[item].FullDescription)
 			</td>
 			<td class="adminData wide">
-				@Html.EditorFor(model => model.Locales[item].FullDescription, Html.RichEditorFlavor())
+				@Html.EditorFor(model => model.Locales[item].FullDescription, "Html")
 				@Html.ValidationMessageFor(model => model.Locales[item].FullDescription)
 			</td>
 		</tr>
@@ -101,7 +101,7 @@
 				@Html.SmartLabelFor(model => model.FullDescription)
 			</td>
 			<td class="adminData wide">
-				@Html.EditorFor(x => x.FullDescription, Html.RichEditorFlavor())
+				@Html.EditorFor(x => x.FullDescription, "Html")
 				@Html.ValidationMessageFor(model => model.FullDescription)
 			</td>
 		</tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/Product/_CreateOrUpdate.Info.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/Product/_CreateOrUpdate.Info.cshtml
@@ -132,7 +132,7 @@
 				@Html.SmartLabelFor(model => model.Locales[item].FullDescription)
 			</td>
 			<td class="adminData wide">
-				@Html.EditorFor(model => model.Locales[item].FullDescription, Html.RichEditorFlavor())
+				@Html.EditorFor(model => model.Locales[item].FullDescription, "Html")
 				@Html.ValidationMessageFor(model => model.Locales[item].FullDescription)
 			</td>
 		</tr>
@@ -162,7 +162,7 @@
 				@Html.SmartLabelFor(model => model.FullDescription)
 			</td>
 			<td class="adminData wide">
-				@Html.EditorFor(x => x.FullDescription, Html.RichEditorFlavor())
+				@Html.EditorFor(x => x.FullDescription, "Html")
 				@Html.ValidationMessageFor(model => model.FullDescription)
 			</td>
 		</tr>
@@ -457,7 +457,7 @@
 					@Html.SmartLabelFor(model => model.UserAgreementText)
 				</td>
 				<td class="adminData wide">
-					@Html.EditorFor(model => model.UserAgreementText, Html.RichEditorFlavor())
+					@Html.EditorFor(model => model.UserAgreementText, "Html")
 					@Html.ValidationMessageFor(model => model.UserAgreementText)
 				</td>
 			</tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/ProductAttribute/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/ProductAttribute/_CreateOrUpdate.cshtml
@@ -57,7 +57,7 @@
 					@Html.SmartLabelFor(model => model.Locales[item].Description)
 				</td>
 				<td class="adminData wide">
-					@Html.EditorFor(model => model.Locales[item].Description, Html.RichEditorFlavor())
+					@Html.EditorFor(model => model.Locales[item].Description, "Html")
 					@Html.ValidationMessageFor(model => model.Locales[item].Description)
 				</td>
 			</tr>
@@ -87,7 +87,7 @@
 					@Html.SmartLabelFor(model => model.Description)
 				</td>
 				<td class="adminData wide">
-					@Html.EditorFor(x => x.Description, Html.RichEditorFlavor())
+					@Html.EditorFor(x => x.Description, "Html")
 					@Html.ValidationMessageFor(model => model.Description)
 				</td>
 			</tr>

diff --git a/src/Presentation/SmartStore.Web/Administration/Views/QueuedEmail/_CreateOrUpdate.cshtml b/src/Presentation/SmartStore.Web/Administration/Views/QueuedEmail/_CreateOrUpdate.cshtml
@@ -80,7 +80,7 @@
             @Html.SmartLabelFor(model => model.Body)
         </td>
         <td class="adminData wide">
-            @Html.EditorFor(model => model.Body, Html.RichEditorFlavor())
+            @Html.EditorFor(model => model.Body, "Html")
             @Html.ValidationMessageFor(model => model.Body)
         </td>
     </tr>