EXT ComponentsBlazor

Blazor is a client side framework utilizing web assemblies. Read more here

This article describes how to inject your own components on specific tagged viewModelColumns - if you rather would like to blanket replace all or some standard components provided by us read this Blazor IComponentTypeSwitchBroker

Components for this framework must be built as blazor web assembly components.

The assemblies you build end up in your bin folder with extension dll - but you will also need to have include the component in Blazor application, because when Visual Studio builds the application it creates further variant files of your assembly that we will need.

Documentation EXT ComponentsBlazor 1725280581631.png

The App is pretty much an empty shell taken straight from the wizard in Visual Studio for the BlazorApp - we add a project reference to the RazorClassLibrary1 (1) project - this is the project that will produce the assembly with our Component1.

RazorClassLibrary1 was created from the wizard RazorComponent. The project makes use of the nuget package MDriven.SharedInterfaces.WebAssembly (2).

In order to be recognized as a full-worthy MDrivenTurnkey component your component must have certain propeties marked as Parameters. Copy and paste this into your a new component (but even better if you make a nuget reference to MDriven.Components.WebAssembly, and put @inherits MDCompBase in the start of your component file - then it will be fully working without the need to add the Parameters below):

@using System.Xml.Linq
@using MDriven.SharedInterfaces.WebAssembly
<div class="my-component">
    This component is defined in the <strong>RazorClassLibrary1</strong> library.
</div>

@code{
  [Parameter]
  public string CompType { set; get; }
  [Parameter]
  public XElement XElement { set; get; }
  [Parameter]
  public string BindInfoColumn { set; get; }
  [Parameter]
  public string BindInfoNesting { set; get; }
  [Parameter]
  public IVMClassObject ContextIVMClassObject { set; get; }
  [Parameter]
  public string RendersAction { set; get; }

  [Parameter]
  public string RendersActionThatUseAbstractAction { set; get; }



  /// <summary>
  /// If the component is used as a grid cell it should probably avoid rendering its label and such
  /// </summary>
  [Parameter]
  public bool IsGridCell { set; get; }

  [Parameter]
  public bool IsGridEditable { set; get; }

  [CascadingParameter(Name = "ViewClient")]
  public IViewClient? ViewClient { get; set; }


}

When we compile our solution we will find the assembly in the bin:

Documentation EXT ComponentsBlazor 1725281478058.png

But we also need the files that are created when VS builds the application, in bin/debug/.net/wwwroot/_framework (these are files able to run on the client in browser context (web assembly)):

Documentation EXT ComponentsBlazor 1725281728809.png

The wasm is the main web-assembly format, but we also want the wasm.gz - that is the gzipped wasm file - and this is what the Turnkey client will want to conserve bandwidth.

To get the dll's and wasm in the same folder (bin\Debug\net8.0), add to the _framework add this to app project:

    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>

Copy these files into your turnkey application/EXT_ComponentsRazor:

Documentation EXT ComponentsBlazor 1725282075308.png

Its the number 1&2 files that are the important ones - one for when running serverside and the other for when running in the browser.

To use the component on a blazor page in Turnkey we set a taggedvalue "Blazor_Ext_Component" on the column where it should be rooted:

Documentation EXT ComponentsBlazor 1725282293864.png

The value of the Blazor_Ext_Component tagged value must be formed like this:

AssemblyNameWithoutExtension;AdditionalAssemblyIfNeededWithoutExtension;AsManyAssembliesAsNeededWithoutExtension;TheTypeOfTheComponent

The component will now render on the page where we used it, check the console for any issues:

Documentation EXT ComponentsBlazor 1725282584664.png
This page was edited 101 days ago on 09/20/2024. What links here