Vorn.Entities.Interface 8.2.0-rc3

Vorn.Entities.Interface

Vorn.Entities.Interface delivers reusable Blazor component bases that understand the entity client contract. The components encapsulate SignalR lifecycle management, paging/search, dialogs, and localization so feature teams can build rich CRUD UIs with minimal boilerplate.

Prerequisites

Add the package to your Blazor project together with the client library and UI dependencies:

dotnet add package Vorn.Entities.Interface
dotnet add package Vorn.Entities.Client
dotnet add package MudBlazor

The components rely on abstractions from Vorn.Entities.Client.SignalR and confirmation dialogs in Vorn.Common.Interface (for the built-in ConfirmDialog/StrictConfirmDialog).

Component catalog

All components expect DTOs/descriptors derived from the common package (EntityDto, EntityDescriptorDto) and a typed client inheriting from EntityClient<TDto, TDescriptorDto>.

Building a list view

Derive from EntityGridBase to get paging, search, and SignalR-driven refresh out of the box:

@inherits DocumentGridBase

<MudDataGrid Items="Items" ServerData="OnGridServerData" Loading="IsBusy">
    <Columns>
        <PropertyColumn Property="@nameof(DocumentDto.Title)" Title="Title" />
        <TemplateColumn>
            <MudButton Variant="Variant.Text" OnClick="() => RowClicked.InvokeAsync(context)">
                Open
            </MudButton>
        </TemplateColumn>
    </Columns>
</MudDataGrid>

@code {
    public sealed class DocumentGridBase
        : EntityGridBase<DocumentClient, DocumentDto, DocumentDescriptorDto>
    {
        protected override void ApplyGridStateToDescriptor(GridState<DocumentDto> state)
            => Descriptor.Search = state.SearchTerms;
    }
}

The base class keeps Descriptor.Skip/Take synchronized with MudBlazor’s paging events and refreshes automatically when EntityNotification events arrive from the server.

Implementing an editor dialog

Use EntityEditorBase to integrate validation, localization, and confirmation dialogs:

public sealed class DocumentEditorBase
    : EntityEditorBase<DocumentClient, DocumentDto, DocumentDescriptorDto, DocumentFormModel>
{
    protected override DocumentFormModel CreateEmptyFormModel() => new();
    protected override DocumentFormModel MapToFormModel(DocumentDto entity)
        => new() { Title = entity.Title };
    protected override DocumentDto MapToDto(DocumentFormModel form)
        => Value is null ? new() { Title = form.Title } : Value with { Title = form.Title };
    protected override string GetDisplayName(DocumentDto entity) => entity.Title;
}

SaveAsync and DeleteAsync are already wired to the underlying client, and the component surfaces IsBusy/ErrorMessage so your Razor markup can provide feedback.

Handling notifications manually

Override OnNotificationAsync on the base component if you need to react to change events directly:

protected override Task OnNotificationAsync(EntityNotification notification)
{
    Snackbar.Add($"{notification.Args.EntityName} {notification.Args.Operation}");
    return RefreshAsync();
}

EntityClientComponentBase automatically subscribes/unsubscribes to notifications as the component is initialized or disposed, and it exposes StopClientOnDispose when you need to control SignalR lifetime.

Tips

• Inject EntityInterceptionConfig to scope user/time metadata across a batch of operations without touching every call site.
• Call SafeRunAsync from derived classes when performing read operations that should toggle IsBusy and capture errors.
• Pair grids and editors within the same page by sharing the descriptor instance—filters applied in the grid automatically flow to editor refreshes.