Empty grid message #25

Author: jehhynes

Griddly.Mvc/EmptyGridMessageTemplateParams.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Griddly.Mvc
+{
+    //TODO: Put GriddlySettings into GriddlyContext so that it doesn't need to be passed in separately
+    public class EmptyGridMessageTemplateParams
+    {
+        public GriddlyResultPage ResultPage { get; set; }
+        public GriddlySettings Settings { get; set; }
+    }
+}

Griddly.Mvc/Griddly.Mvc.csproj

@@ -87,6 +87,7 @@
       <Link>Properties\CommonAssemblyInfo.cs</Link>
     </Compile>
     <Compile Include="DynamicLinq.cs" />
+    <Compile Include="EmptyGridMessageTemplateParams.cs" />
     <Compile Include="Exceptions\DapperGriddlyException.cs" />
     <Compile Include="GriddlyContext.cs" />
     <Compile Include="GriddlyCookieFilterValueProvider.cs" />

Griddly.Mvc/GriddlySettings.cs

@@ -83,6 +83,8 @@ public GriddlySettings()
             TableClassName = Css.TableDefault;
             FooterTemplate = DefaultFooterTemplate;
             HeaderTemplate = DefaultHeaderTemplate;
+            EmptyGridMessageTemplate = DefaultEmptyGridMessageTemplate;
+            EmptyGridMessage = DefaultEmptyGridMessage;
             PageSize = DefaultPageSize;
             InitialFilterMode = DefaultInitialFilterMode;
             //AllowedFilterModes = DefaultAllowedFilterModes;
@@ -149,6 +151,11 @@ public static void ConfigureBootstrap4Defaults()
         public Func<GriddlyResultPage, object> FooterTemplate { get; set; }
         public Func<GriddlyResultPage, object> HeaderTemplate { get; set; }
 
+        public static Func<EmptyGridMessageTemplateParams, object> DefaultEmptyGridMessageTemplate { get; set; }
+        public Func<EmptyGridMessageTemplateParams, object> EmptyGridMessageTemplate { get; set; }
+        public static string DefaultEmptyGridMessage { get; set; }
+        public string EmptyGridMessage { get; set; }
+
         public Dictionary<string, Func<object, object>> RowIds { get; protected set; }
 
         public virtual bool HasRowClickUrl

Griddly/Scripts/griddly.js

@@ -1696,10 +1696,13 @@
                 // https://github.com/programcsharp/griddly/issues/79
                 this.$element.find("tbody.data").html(html.children("tbody").html());
 
-                var tfoot = this.$element.find("tfoot");
+                var tfoot = this.$element.find("tfoot.totals-tfoot");
+                if (tfoot.length && html.children("tfoot.totals-tfoot").length)
+                    tfoot.replaceWith(html.children("tfoot.totals-tfoot"));
 
-                if (tfoot.length && html.children("tfoot").length)
-                    tfoot.replaceWith(html.children("tfoot"));
+                var emptyMessage = this.$element.find("tfoot.empty-grid-message");
+                if (emptyMessage.length && html.children("tfoot.empty-grid-message").length)
+                    emptyMessage.replaceWith(html.children("tfoot.empty-grid-message"));
 
                 var startRecord = this.options.pageNumber * this.options.pageSize;
 

Griddly/Views/Home/FilterBoxGrid.cshtml

@@ -39,7 +39,9 @@
         {
             new GriddlyButton() { Text = "Dropdown Test" }
                 .Add(new GriddlyButton() { Text = "UrlHelper Test", Argument = Url.Action("About") })
-        }
+        }, 
+        EmptyGridMessageTemplate=@<text><div class="alert alert-warning">@item.Settings.EmptyGridMessage</div></text>,
+        EmptyGridMessage="Sorry, no records were found"
     }
     .Column(x => x.Id, filter: x => x.FilterBox(FilterDataType.Integer))
     .Column(x => x.Item, filter: x => x.FilterList(groupedList))

Griddly/Views/Shared/Griddly/Griddly.cshtml

@@ -286,7 +286,7 @@
 </tbody>
 @if (settings.Columns.Any(x => x.SummaryFunction != null || x.SummaryValue != null))
 {
-    <tfoot>
+    <tfoot class="totals-tfoot">
         <tr>
             @foreach (GriddlyColumn column in settings.Columns)
             {
@@ -295,10 +295,29 @@
         </tr>
     </tfoot>
 }
+
+@if (settings.EmptyGridMessage != null) {
+    <tfoot class="empty-grid-message" style="@(Model.Total > 0 ? "display:none;" : null)">
+        <tr>
+            <td colspan="@settings.Columns.Count">
+                @if (settings.EmptyGridMessageTemplate != null)
+                {
+                    @settings.EmptyGridMessageTemplate(new EmptyGridMessageTemplateParams() { ResultPage = Model, Settings = settings })
+                }
+                else
+                {
+                    @Model.Settings.EmptyGridMessage
+                }
+            </td>
+        </tr>
+    </tfoot>
+}
+
 @if (isFirstRender)
 {
-    @:</table>
-    @:</div>
+@:</table>
+@:</div>
+
     <div class="griddly-footer">
         @if (settings.FooterTemplate == null || simple)
         {