Added comments to EditPortfolio.razor and Index.razor

Author: topnax

WebFrontend/Pages/EditPortfolio.razor

@@ -5,36 +5,29 @@
 @inject IPortfolioService PortfolioService
 @inject IMatDialogService MatDialogService
 @inject IMatToaster Toaster
-@inject Microsoft.AspNetCore.Components.NavigationManager NavigationManager
+@inject NavigationManager NavigationManager
 
 
 <style>
-    .demo-mat-card {
-        max-width: 400px;
-        margin-bottom: 2em;
-    }
-
     .demo-mat-card-content {
         padding: 1rem;
     }
-
-    .clear-margin {
-        margin: 0px;
-    }
 </style>
 
 <div class="mat-layout-grid">
     <div class="mat-layout-grid-inner">
         <div class="mat-layout-grid-cell mat-layout-grid-cell-span-2"></div>
         <div class="mat-layout-grid-cell mat-layout-grid-cell-span-8">
-            <MatH5><MatButton Outlined="true" Icon="keyboard_arrow_left" Style="margin-right: 1rem;" OnClick='() => { NavigationManager.NavigateTo($""); }'>Back</MatButton></MatH5>
+            <MatH5>
+                <MatButton Outlined="true" Icon="keyboard_arrow_left" Style="margin-right: 1rem;" OnClick='() => { NavigationManager.NavigateTo($""); }'>Back</MatButton>
+            </MatH5>
             <MatCard>
                 <MatCardContent class="demo-mat-card-content">
                     <h2>Edit portfolio</h2>
                     <PortfolioForm
                         DefaultCurrency="@Currency.Usd"
                         AvailableCurrencies="@(EnumUtils.GetEnumList<Currency>())"
-                        FormModel="FormModel"
+                        FormModel="_formModel"
                         Edit="true"
                         OnSubmitEventHandler="@OnCreateFormSubmitted">
                     </PortfolioForm>
@@ -48,27 +41,38 @@
 
 @code
 {
-    [Parameter] public int PortfolioId { get; set; }
+    // ID of the portfolio to be edited
+    [Parameter]
+    public int PortfolioId { get; set; }
+
+    // model of the form
+    private readonly PortfolioForm.NewPortfolioModel _formModel = new(Currency.Usd);
 
-    public PortfolioForm.NewPortfolioModel FormModel = new(Currency.Usd);
-    
-    public Portfolio ActivePortfolio;
+    // currently edited portfolio
+    private Portfolio _activePortfolio;
 
     protected override void OnInitialized()
     {
-        ActivePortfolio = PortfolioService.GetPortfolio(PortfolioId);
-        FormModel.Name = ActivePortfolio.Name;
-        FormModel.Description = ActivePortfolio.Description;
+        // find the portfolio
+        _activePortfolio = PortfolioService.GetPortfolio(PortfolioId);
+        
+        // update the form model
+        _formModel.Name = _activePortfolio.Name;
+        _formModel.Description = _activePortfolio.Description;
     }
 
     private void OnCreateFormSubmitted(PortfolioForm.NewPortfolioModel formModel)
     {
-        PortfolioService.UpdatePortfolio(ActivePortfolio with {
+        // update the portfolio
+        PortfolioService.UpdatePortfolio(_activePortfolio with {
             Name = formModel.Name,
             Description = formModel.Description
             });
+        // reset the form 
         formModel.Reset();
         Toaster.Add("Portfolio successfully edited", MatToastType.Success, "", "");
-        NavigationManager.NavigateTo($"/portfolios/{ActivePortfolio.Id}");
+        
+        // navigate back to the portfolio detail
+        NavigationManager.NavigateTo($"/portfolios/{_activePortfolio.Id}");
     }
 }

WebFrontend/Pages/Index.razor

@@ -1,8 +1,8 @@
 @page "/"
-@using Model
 @using Services
 @using Utils
-@inject Microsoft.AspNetCore.Components.NavigationManager NavigationManager
+@using Model
+@inject NavigationManager NavigationManager
 @inject IPortfolioService PortfolioService
 @inject IPortfolioEntryService PortfolioEntryService
 @inject IMatDialogService MatDialogService
@@ -26,33 +26,29 @@
         bottom: 1rem;
         right: 1rem;
     }
-    
-    .mat-paper {
-        display: flex;
-        flex-direction: column;
-        justify-content: center;
-        align-items: center;
-        padding: 1em;
-    } 
-    
 </style>
 <div class="mat-layout-grid mat-layout-grid-align-center">
     <div class="mat-layout-grid-inner center">
 
         <div class="mat-layout-grid-cell mat-layout-grid-cell-span-2"></div>
         <div class="mat-layout-grid-cell mat-layout-grid-cell-span-8">
             <MatH5>Portfolios</MatH5>
-            @if (PortfoliosWithEntries == null)
+            @if (_portfoliosWithEntries == null)
             {
                 <MatProgressBar Indeterminate="true"></MatProgressBar>
             }
-            else if (PortfoliosWithEntries.Count < 1)
+            else if (_portfoliosWithEntries.Count < 1)
             {
-                <MatPaper Elevation="2"><span>No portfolios were found.</span><div><MatButton Style="margin-top:1em;" Label="Create a new portfolio" OnClick='() => { NavigationManager.NavigateTo($"newportfolio");}'></MatButton></div></MatPaper>
+                <MatPaper Elevation="2">
+                    <span>No portfolios were found.</span>
+                    <div>
+                        <MatButton Style="margin-top:1em;" Label="Create a new portfolio" OnClick='() => { NavigationManager.NavigateTo($"newportfolio"); }'></MatButton>
+                    </div>
+                </MatPaper>
             }
             else
             {
-                @foreach (var portfolioWithEntries in PortfoliosWithEntries)
+                @foreach (var portfolioWithEntries in _portfoliosWithEntries)
                 {
                     <MatCard class="demo-mat-card" OnCli>
                         <MatCardContent>
@@ -96,12 +92,13 @@
         <div class="mat-layout-grid-cell mat-layout-grid-cell-span-2"></div>
     </div>
 </div>
-<MatFAB Class="app-fab--absolute" Icon="@MatIconNames.Add" Label="Add a new portfolio" OnClick='() => { NavigationManager.NavigateTo($"newportfolio");}'></MatFAB>
+<MatFAB Class="app-fab--absolute" Icon="@MatIconNames.Add" Label="Add a new portfolio" OnClick='() => { NavigationManager.NavigateTo($"newportfolio"); }'></MatFAB>
 
 
 @code
 {
-    protected List<Tuple<Portfolio, List<PortfolioEntry>>> PortfoliosWithEntries;
+    // list of portfolios with entries mapped to them
+    private List<Tuple<Portfolio, List<PortfolioEntry>>> _portfoliosWithEntries;
 
     protected record PortfolioEntryRow(string symbol, decimal currentPrice, decimal relativeChange, decimal percentage);
 
@@ -112,7 +109,7 @@
 
     private void LoadPortfolios()
     {
-        PortfoliosWithEntries = PortfolioService.GetPortfolios().Select(
+        _portfoliosWithEntries = PortfolioService.GetPortfolios().Select(
             portfolio => new Tuple<Portfolio, List<PortfolioEntry>>(
                 portfolio,
                 PortfolioEntryService.GetPortfolioEntries(portfolio.Id)
@@ -127,11 +124,15 @@
 
     private async void DeletePortfolio(Portfolio portfolio)
     {
+        // let user confirm whether he wants to delete the portfolio
         var result = await MatDialogService.ConfirmAsync("Do you really wish to delete this portfolio including all of it's portfolio entries and market orders?");
         if (result)
         {
+            // delete portfolio
             PortfolioService.DeletePortfolio(portfolio);
+            // reload the portfolio list 
             LoadPortfolios();
+            // refresh the UI
             StateHasChanged();
             Toaster.Add($"Portfolio \"{portfolio.Name}\" sucessfully deleted", MatToastType.Info, "", "");
         }
@@ -141,7 +142,7 @@
     {
         NavigationManager.NavigateTo($"/newportfolioentry/{portfolio.Id}");
     }
-    
+
     private void ViewPortfolio(Portfolio portfolio)
     {
         NavigationManager.NavigateTo($"/portfolios/{portfolio.Id}");