improvements for entitytable

fretje · fretje · commit 496c0382bf23 · 2022-01-26T16:09:05.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -1,6 +1,10 @@
 root = true
 
 [*]
+roslynator_accessibility_modifiers = explicit
+roslynator_use_anonymous_function_or_method_group = anonymous_function|method_group
+roslynator_enum_has_flag_style = method
+roslynator_object_creation_type_style = explicit|implicit|implicit_when_type_is_obvious
 
 indent_style = space
 
diff --git a/src/Client/Components/EntityTable/AddEditModal.razor b/src/Client/Components/EntityTable/AddEditModal.razor
@@ -10,27 +10,22 @@
                 @if (IsCreate)
                 {
                     <MudIcon Icon="@Icons.Material.Filled.Add" Class="mr-3 mb-n1" />
+                    @($"{L["Create"]} {EntityName}");
                 }
                 else
                 {
                     <MudIcon Icon="@Icons.Material.Filled.Update" Class="mr-3 mb-n1" />
+                    @($"{L["Edit"]} {EntityName} {Id}");
                 }
-                @Title
             </MudText>
         </TitleContent>
 
         <DialogContent>
             <DataAnnotationsValidator />
             <CustomValidation @ref="_customValidation" />
             <MudGrid>
-                @if (!IsCreate)
-                {
-                    <MudItem xs="12" md="6">
-                        <MudTextField Disabled For="@(() => Id)" @bind-Value="Id" Label="@L["Id"]" />
-                    </MudItem>
-                }
 
-                @EditFormContent(RequestModel!)
+                @EditFormContent(RequestModel)
 
             </MudGrid>
         </DialogContent>
diff --git a/src/Client/Components/EntityTable/AddEditModal.razor.cs b/src/Client/Components/EntityTable/AddEditModal.razor.cs
@@ -5,7 +5,7 @@
 
 namespace FSH.BlazorWebAssembly.Client.Components.EntityTable;
 
-public partial class AddEditModal<TRequest> : IAddEditModal
+public partial class AddEditModal<TRequest> : IAddEditModal<TRequest>
 {
     [Parameter]
     [EditorRequired]
@@ -22,9 +22,7 @@ public partial class AddEditModal<TRequest> : IAddEditModal
 
     [Parameter]
     [EditorRequired]
-    public string Title { get; set; } = default!;
-    [Parameter]
-    public bool IsCreate { get; set; }
+    public string EntityName { get; set; } = default!;
     [Parameter]
     public object? Id { get; set; }
 
@@ -33,13 +31,9 @@ public partial class AddEditModal<TRequest> : IAddEditModal
 
     private CustomValidation? _customValidation;
 
-    protected override Task OnInitializedAsync() =>
-        OnInitializedFunc is not null
-            ? OnInitializedFunc()
-            : Task.CompletedTask;
+    public bool IsCreate => Id is null;
 
-    public void ForceRender() =>
-        StateHasChanged();
+    public void ForceRender() => StateHasChanged();
 
     // This should not be necessary anymore, except maybe in the case when the
     // UpdateEntityRequest has different validation rules than the CreateEntityRequest.
@@ -75,6 +69,11 @@ public bool Validate(object request)
         return true;
     }
 
+    protected override Task OnInitializedAsync() =>
+        OnInitializedFunc is not null
+            ? OnInitializedFunc()
+            : Task.CompletedTask;
+
     private async Task SaveAsync()
     {
         if (await ApiHelper.ExecuteCallGuardedAsync(
diff --git a/src/Client/Components/EntityTable/EntityTable.razor b/src/Client/Components/EntityTable/EntityTable.razor
@@ -16,18 +16,18 @@
         @if (_canSearch && (Context.AdvancedSearchEnabled || AdvancedSearchContent is not null))
         {
             <MudExpansionPanel @bind-IsExpanded="_advancedSearchExpanded"
-            Style="padding:10px!important; margin-bottom:10px!important;border-radius: var(--mud-default-borderradius) !important;"
-            Class="mud-elevation-25" Text="@L["Advanced Search"]">
+                Style="padding:10px!important; margin-bottom:10px!important;border-radius: var(--mud-default-borderradius) !important;"
+                Class="mud-elevation-25" Text="@L["Advanced Search"]">
                 <MudTextField @bind-Value="SearchString" Immediate="true"
-                Placeholder="@(L["Search for "] + Context.EntityNamePlural)" Adornment="Adornment.Start"
-                AdornmentIcon="@Icons.Material.Filled.Search" IconSize="Size.Medium"
-                Style="flex:none!important;margin:0px!important" TextChanged="OnSearchStringChanged">
+                    Placeholder="@(L["Search for "] + Context.EntityNamePlural)" Adornment="Adornment.Start"
+                    AdornmentIcon="@Icons.Material.Filled.Search" IconSize="Size.Medium"
+                    Style="flex:none!important;margin:0px!important" TextChanged="OnSearchStringChanged">
                 </MudTextField>
                 @if (Context.AdvancedSearchEnabled)
                 {
                     <div style="margin-top:10px!important">
                         <MudCheckBox Label="All Columns" T="bool" Checked="Context.AllColumnsChecked"
-                    CheckedChanged="Context.AllColumnsCheckChanged"></MudCheckBox>
+                            CheckedChanged="Context.AllColumnsCheckChanged"></MudCheckBox>
                         @foreach (var field in Context.Fields)
                         {
                             <MudCheckBox @bind-Checked="@field.CheckedForSearch" Label="@(field.DisplayName)"></MudCheckBox>
@@ -48,8 +48,8 @@
                     @if (_canCreate)
                     {
                         <MudButton DisableElevation Variant="Variant.Filled" Color="Color.Primary"
-                        OnClick="(() => InvokeModal())" StartIcon="@Icons.Material.Filled.Add"
-                        IconColor="Color.Surface">@L["Create"]</MudButton>
+                            OnClick="(() => InvokeModal())" StartIcon="@Icons.Material.Filled.Add"
+                            IconColor="Color.Surface">@L["Create"]</MudButton>
                     }
                     <MudButton DisableElevation Variant="Variant.Filled" OnClick="ResetAsync"
                         StartIcon="@Icons.Material.Filled.Refresh" IconColor="Color.Surface" Color="Color.Secondary"
@@ -59,9 +59,9 @@
                 @if (_canSearch && !_advancedSearchExpanded)
                 {
                     <MudTextField @bind-Value="SearchString" Immediate="true" FullWidth="false"
-                    Placeholder="@(L["Search for "] + Context.EntityNamePlural)" Adornment="Adornment.End"
-                    AdornmentIcon="@Icons.Material.Filled.Search" IconSize="Size.Medium" Class="mt-0 mb-3"
-                    TextChanged="OnSearchStringChanged">
+                        Placeholder="@(L["Search for "] + Context.EntityNamePlural)" Adornment="Adornment.End"
+                        AdornmentIcon="@Icons.Material.Filled.Search" IconSize="Size.Medium" Class="mt-0 mb-3"
+                        TextChanged="OnSearchStringChanged">
                     </MudTextField>
                 }
             </ToolBarContent>
@@ -94,16 +94,13 @@
                         {
                             @field.Template(context)
                         }
+                        else if (field.Type == typeof(bool))
+                        {
+                            <MudCheckBox Checked="@field.ValueFunc(context)" ReadOnly Color="Color.Secondary"></MudCheckBox>
+                        }
                         else
                         {
-                            if (field.Type == typeof(bool))
-                            {
-                                <MudCheckBox Checked="@field.ValueFunc(context)" ReadOnly Color="Color.Secondary"></MudCheckBox>
-                            }
-                            else
-                            {
-                                <MudHighlighter Text="@field.ValueFunc(context)?.ToString()" HighlightedText="@SearchString" />
-                            }
+                            <MudHighlighter Text="@field.ValueFunc(context)?.ToString()" HighlightedText="@SearchString" />
                         }
                     </MudTd>
                 }
@@ -115,8 +112,8 @@
                     else if (HasActions)
                     {
                         <MudMenu Label="@L["Actions"]" Variant="Variant.Filled" DisableElevation="true"
-                        EndIcon="@Icons.Filled.KeyboardArrowDown" IconColor="Color.Secondary" Direction="Direction.Left"
-                        OffsetX="true">
+                            EndIcon="@Icons.Filled.KeyboardArrowDown" IconColor="Color.Secondary" Direction="Direction.Left"
+                            OffsetX="true">
                             @if (CanUpdateEntity(context))
                             {
                                 <MudMenuItem @onclick="@(() => InvokeModal(context))">@L["Edit"]</MudMenuItem>
@@ -134,7 +131,7 @@
                     else
                     {
                         <MudButton Variant="Variant.Filled" DisableElevation="true"
-                        StartIcon="@Icons.Material.Filled.DoNotTouch" IconColor="Color.Secondary" Size="Size.Small"
+                            StartIcon="@Icons.Material.Filled.DoNotTouch" IconColor="Color.Secondary" Size="Size.Small"
                         Color="Color.Surface">
                             @L["No Allowed Actions"]
                         </MudButton>
diff --git a/src/Client/Components/EntityTable/EntityTable.razor.cs b/src/Client/Components/EntityTable/EntityTable.razor.cs
@@ -73,24 +73,28 @@ protected override async Task OnInitializedAsync()
         _canDelete = await CanDoPermission(Context.DeletePermission, state);
 
         await LocalLoadDataAsync();
-        await SubscribeToTableCustomizationPanel();
+        await SetAndSubscribeToTablePreference();
     }
 
-    private async Task SubscribeToTableCustomizationPanel()
+    private async Task SetAndSubscribeToTablePreference()
     {
-        if (await ClientPreferences.GetPreference() is not ClientPreference currentPreference) return;
-        Dense = currentPreference.EntityTablePreference.IsDense;
-        Striped = currentPreference.EntityTablePreference.IsStriped;
-        Bordered = currentPreference.EntityTablePreference.HasBorder;
-        Hoverable = currentPreference.EntityTablePreference.IsHoverable;
-        MessagingCenter.Subscribe<TableCustomizationPanel, EntityTablePreference>(this, nameof(currentPreference.EntityTablePreference), (_, value) =>
+        if (await ClientPreferences.GetPreference() is ClientPreference clientPreference)
         {
-            Dense = value.IsDense;
-            Striped = value.IsStriped;
-            Bordered = value.HasBorder;
-            Hoverable = value.IsHoverable;
-            StateHasChanged();
-        });
+            SetTablePreference(clientPreference.EntityTablePreference);
+            MessagingCenter.Subscribe<TableCustomizationPanel, EntityTablePreference>(this, nameof(ClientPreference.EntityTablePreference), (_, value) =>
+                {
+                    SetTablePreference(value);
+                    StateHasChanged();
+                });
+        }
+    }
+
+    private void SetTablePreference(EntityTablePreference tablePreference)
+    {
+        Dense = tablePreference.IsDense;
+        Striped = tablePreference.IsStriped;
+        Bordered = tablePreference.HasBorder;
+        Hoverable = tablePreference.IsHoverable;
     }
 
     private async Task<bool> CanDoPermission(string? permission, AuthenticationState state) =>
@@ -208,31 +212,27 @@ private async Task InvokeModal(TEntity? entity = default)
     {
         bool isCreate = entity is null;
 
-        string title = isCreate
-            ? L["Create "] + Context.EntityName
-            : L["Update "] + Context.EntityName;
-
         var parameters = new DialogParameters()
         {
             { nameof(AddEditModal<TRequest>.EditFormContent), EditFormContent },
             { nameof(AddEditModal<TRequest>.OnInitializedFunc), Context.EditFormInitializedFunc },
-            { nameof(AddEditModal<TRequest>.IsCreate), isCreate },
-            { nameof(AddEditModal<TRequest>.Title), title }
+            { nameof(AddEditModal<TRequest>.EntityName), Context.EntityName }
         };
 
+        TRequest requestModel;
+
         if (isCreate)
         {
             _ = Context.CreateFunc ?? throw new InvalidOperationException("CreateFunc can't be null!");
             parameters.Add(nameof(AddEditModal<TRequest>.SaveFunc), Context.CreateFunc);
 
-            var requestModel =
+            requestModel =
                 Context.GetDefaultsFunc is not null
                     && await ApiHelper.ExecuteCallGuardedAsync(
                             () => Context.GetDefaultsFunc(), Snackbar)
                         is TRequest defaultsResult
                 ? defaultsResult
                 : new TRequest();
-            parameters.Add(nameof(AddEditModal<TRequest>.RequestModel), requestModel);
         }
         else
         {
@@ -244,17 +244,18 @@ is TRequest defaultsResult
             Func<TRequest, Task> saveFunc = entity => Context.UpdateFunc(id, entity);
             parameters.Add(nameof(AddEditModal<TRequest>.SaveFunc), saveFunc);
 
-            var requestModel =
+            requestModel =
                 Context.GetDetailsFunc is not null
                     && await ApiHelper.ExecuteCallGuardedAsync(
                             () => Context.GetDetailsFunc(id!),
                             Snackbar)
                         is TRequest detailsResult
                 ? detailsResult
                 : entity!.Adapt<TRequest>();
-            parameters.Add(nameof(AddEditModal<TRequest>.RequestModel), requestModel);
         }
 
+        parameters.Add(nameof(AddEditModal<TRequest>.RequestModel), requestModel);
+
         var options = new DialogOptions { CloseButton = true, MaxWidth = MaxWidth.Medium, FullWidth = true, DisableBackdropClick = true };
 
         var dialog = DialogService.Show<AddEditModal<TRequest>>(isCreate ? L["Create"] : L["Edit"], parameters, options);
diff --git a/src/Client/Components/EntityTable/EntityTableContext.cs b/src/Client/Components/EntityTable/EntityTableContext.cs
@@ -150,13 +150,15 @@ public EntityTableContext(
         CanDeleteEntityFunc = canDeleteEntityFunc;
     }
 
+    // AddEdit modal
     private IDialogReference? _addEditModalRef;
 
     internal void SetAddEditModalRef(IDialogReference dialog) =>
         _addEditModalRef = dialog;
 
-    public IAddEditModal? AddEditModal =>
-        _addEditModalRef?.Dialog as IAddEditModal;
+    public IAddEditModal<TRequest> AddEditModal =>
+        _addEditModalRef?.Dialog as IAddEditModal<TRequest>
+        ?? throw new InvalidOperationException("AddEditModal is only available when the modal is shown.");
 
     // Shortcuts
     public EntityClientTableContext<TEntity, TId, TRequest>? ClientContext => this as EntityClientTableContext<TEntity, TId, TRequest>;
diff --git a/src/Client/Components/EntityTable/IAddEditModal.cs b/src/Client/Components/EntityTable/IAddEditModal.cs
@@ -1,7 +1,9 @@
 ﻿namespace FSH.BlazorWebAssembly.Client.Components.EntityTable;
 
-public interface IAddEditModal
+public interface IAddEditModal<TRequest>
 {
+    TRequest RequestModel { get; }
+    bool IsCreate { get; }
     void ForceRender();
     bool Validate(object request);
 }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`namespace FSH.BlazorWebAssembly.Client.Components.EntityTable;`
`2`	`2`
`3`		`-public interface IAddEditModal`
	`3`	`+public interface IAddEditModal<TRequest>`
`4`	`4`	`{`
	`5`	`+ TRequest RequestModel { get; }`
	`6`	`+ bool IsCreate { get; }`
`5`	`7`	`void ForceRender();`
`6`	`8`	`bool Validate(object request);`
`7`	`9`	`}`