Shiny.Mediator.Blazor 1.0.0-alpha-0012

Prefix Reserved
This is a prerelease version of Shiny.Mediator.Blazor.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator.Blazor --version 1.0.0-alpha-0012
                    
NuGet\Install-Package Shiny.Mediator.Blazor -Version 1.0.0-alpha-0012
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Shiny.Mediator.Blazor" Version="1.0.0-alpha-0012" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shiny.Mediator.Blazor" Version="1.0.0-alpha-0012" />
                    
Directory.Packages.props
<PackageReference Include="Shiny.Mediator.Blazor" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Shiny.Mediator.Blazor --version 1.0.0-alpha-0012
                    
#r "nuget: Shiny.Mediator.Blazor, 1.0.0-alpha-0012"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Shiny.Mediator.Blazor&version=1.0.0-alpha-0012&prerelease
                    
Install Shiny.Mediator.Blazor as a Cake Addin
#tool nuget:?package=Shiny.Mediator.Blazor&version=1.0.0-alpha-0012&prerelease
                    
Install Shiny.Mediator.Blazor as a Cake Tool

Shiny Mediator (Preview)

<a href="https://www.nuget.org/packages/Shiny.Mediator" target="_blank"> <img src="https://buildstats.info/nuget/Shiny.Mediator" /> </a>

A mediator pattern, but for apps. Apps have pages with lifecycles that don't necessarily participate in the standard dependency injection lifecycle. .NET MAUI generally tends to favor the Messenger pattern. We hate this pattern for many reasons which we won't get into. That being said, we do offer a messenger subscription in our Mediator for where interfaces and dependency injection can't reach.

Features

  • A Mediator for your .NET Apps (MAUI & Blazor are the main targets for us)
  • Think of "weak" message subscription without the fuss or mess to cleanup
  • Fire & Forget as well as Parallel Event execution
  • Our MAUI & Blazor integrations allow your viewmodels or pages to implement an IEventHandler<TEvent> interface(s) without them having to participate in the dependency injection provider
  • We still have a "messagingcenter" type subscribe off IMediator for cases where you can't have your current type implement an interface
  • Instead of Assembly Scanning, we have source generators to automatically wireup the necessary registrations for you!
  • Lightweight, No external dependencies, tiny bit of reflection
  • Help remove service overrun and reduce your constructor fat
  • Easy to Unit Test

Works With

  • .NET MAUI - all platforms
  • MVVM Frameworks like Prism, ReactiveUI, & .NET MAUI Shell
  • Blazor - TBD
  • Any other .NET platform - but you'll have to come up with your own "event collector" for the out-of-state stuff

Getting Started

First, let's create our request & event handlers

using Shiny.Mediator;

public record TestRequest(string AnyArgs, int YouWant) : IRequest;
public record TestEvent(MyObject AnyArgs) : IEvent;

// and for request/response requests - we'll come back to this
public record TestResponseRequest : IRequest<TestResponse> {}
public record TestResponse {}

Next - let's wire up a RequestHandler. You can have ONLY 1 request handler per request type. This is where you would do the main business logic or data requests.

Let's create our RequestHandler

using Shiny.Mediator;

// NOTE: Request handlers are registered as singletons
public class TestRequestHandler : IRequestHandler<TestRequest> 
{
    // you can do all dependency injection here
    public async Task Handle(TestRequest request, CancellationToken ct) 
    {
        // do something async here
    }
}

public class TestResponseRequestHandler : IRequestHandler<TestResponseRequest, TestResponse>
{
    public async Task<TestResponse> Handle(TestResponseRequest request, CancellationToken ct)
    {
        var response = await GetResponseThing(ct);
        return response;
    }
}

public class TestEventHandler : IEventHandler<TestEvent> 
{
    // Dependency injection works here
    public async Task Handle(TestEvent @event, CancellationToken ct)
    {
        // Do something async here
    }
}

Now, let's register all of our stuff with our .NET MAUI MauiProgram.cs

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp
            .CreateBuilder()
            .UseMauiApp<App>();
        
        builder.Services.AddShinyMediator();
        builder.Services.AddSingletonAsImplementedInterfaces<TestEventHandler>();
        builder.Services.AddSingletonAsImplementedInterfaces<TestRequestHandler>();
        builder.Services.AddSingltonAsImplementedInterfaces<TestResponseRequestHandler>();
        // OR if you're using our attribute for source generation
    }
}

Lastly, any model model/viewmodel/etc participating in dependency injection can now inject the mediator

public class MyViewModel(Shiny.Mediator.IMediator mediator)
{
    public async Task Execute() 
    {
        await mediator.Send(new TestRequest()); // this will execute TestRequestHandler
        var response = await mediator.Send(new TestResponseRequest()); // this will execute TestResponseRequestHandler and return a value
        
        // this will publish to any service registered that implement IEventHandler<TestEvent>
        // there are additional args here to allow you to execute values in sequentially or wait for all events to complete
        // by default, publish calls are "fire & forget" under the hood and execute in parallel
        await mediator.Publish(new TestEvent()); 
    }
}

What about my ViewModels?

For .NET MAUI, your viewmodels have the ability to participate in the event publishing chain without being part of dependency injection

With this setup, you don't need to worry about deallocating any events, unsubscribing from some service, or hooking to anything.

Lastly, if your page/viewmodel is navigated away from (popped), it will no longer participate in the event broadcast

Let's go back to MauiProgram.cs and alter the AddShinyMediator

builder.Services.AddShinyMediator<MauiEventCollector>();

Now your viewmodel (or page) can simply implement the IEventHandler<T> interface to participate

NOTE: Further example to below - you can implement multiple event handlers (or request handlers)

public class MyViewModel : BaseViewModel, 
                           Shiny.Mediator.IEventHandler<TestEvent>,
                           Shiny.Mediator.IEventHandler<TestEvent>
{
    public async Task Handle(TestEvent @event, CancellationToken ct)
    {
    }
    
    public async Task Handle(TestEvent2 @event, CancellationToken ct)
    {
    }
}

Sample

There is a sample in this repo. You do not need any other part of Shiny, Prism, ReactiveUI, etc - those are included as I write things faster with it. Focus on the interfaces from the mediator & the mediator calls itself

Ideas for Workflows

  • Use Prism with Modules - want strongly typed navigation parameters, navigations, and have them available to other modules - we're the guy to help!
    • Example TBD
  • Using a Shiny Foreground Job - want to push data an event that new data came in to anyone listening?
  • Have a Shiny Push Delegate that is executing on the delegate but want to push it to the UI, Mediator has a plan!

TODO

  • Pipelines
    • Error handlers - requests and events?
    • Pre/Post Execution - Time how long events took, time how long a command took
  • Explain Event Handlers
  • Streams - IAsyncEnumerable or IObservable
  • Source Generator Registration
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.4.0-beta-0023 110 5/29/2025
4.4.0-beta-0021 106 5/29/2025
4.4.0-beta-0018 128 5/26/2025
4.4.0-beta-0017 124 5/26/2025
4.4.0-beta-0015 121 5/26/2025
4.4.0-beta-0014 128 5/26/2025
4.4.0-beta-0004 79 5/25/2025
4.2.2 57 5/24/2025
4.2.1 141 5/8/2025
4.2.0 96 4/25/2025
4.2.0-beta-0010 134 5/8/2025
4.2.0-beta-0009 129 5/8/2025
4.2.0-beta-0008 86 4/25/2025
4.2.0-beta-0001 171 4/16/2025
4.1.0 141 3/28/2025
4.1.0-beta-0001 125 3/28/2025
4.0.4 405 3/24/2025
4.0.4-beta-0001 388 3/24/2025
4.0.3 259 3/23/2025
4.0.3-beta-0007 251 3/23/2025
4.0.2 69 3/15/2025
4.0.1 209 3/5/2025
4.0.1-beta-0010 140 3/19/2025
4.0.1-beta-0009 60 3/15/2025
4.0.1-beta-0001 190 3/5/2025
4.0.0 205 3/4/2025
4.0.0-beta-0021 190 3/4/2025
4.0.0-beta-0017 193 3/4/2025
4.0.0-beta-0016 195 3/4/2025
4.0.0-beta-0010 82 3/2/2025
4.0.0-beta-0009 79 3/2/2025
4.0.0-beta-0002 83 3/1/2025
3.3.1 107 2/20/2025
3.3.0 92 2/20/2025
3.3.0-beta-0028 84 2/20/2025
3.3.0-beta-0025 81 2/19/2025
3.3.0-beta-0024 86 2/19/2025
3.3.0-beta-0004 82 2/8/2025
3.2.0 87 1/29/2025
3.2.0-beta-0027 71 1/29/2025
3.2.0-beta-0023 73 1/29/2025
3.2.0-beta-0020 75 1/29/2025
3.1.3 83 1/29/2025
3.1.2 82 1/28/2025
3.1.1 89 1/25/2025
3.1.0 84 1/25/2025
3.1.0-beta-0013 76 1/25/2025
3.1.0-beta-0006 74 1/25/2025
3.1.0-beta-0004 76 1/25/2025
3.0.0 84 1/24/2025
3.0.0-beta-0055 73 1/24/2025
3.0.0-beta-0046 73 1/23/2025
3.0.0-beta-0045 73 1/23/2025
3.0.0-beta-0043 79 1/23/2025
3.0.0-beta-0038 79 1/21/2025
3.0.0-beta-0037 84 1/21/2025
3.0.0-beta-0029 84 1/21/2025
3.0.0-beta-0028 77 1/21/2025
3.0.0-beta-0018 74 1/19/2025
3.0.0-beta-0016 57 1/14/2025
3.0.0-beta-0012 83 1/12/2025
3.0.0-beta-0008 84 1/2/2025
3.0.0-beta-0007 80 12/28/2024
3.0.0-beta-0004 90 12/22/2024
2.2.0-beta-0001 83 10/28/2024
2.1.1 117 10/28/2024
2.1.0 120 10/19/2024
2.1.0-beta-0016 84 10/19/2024
2.1.0-beta-0015 82 10/19/2024
2.1.0-beta-0014 95 10/19/2024
2.1.0-beta-0013 103 10/19/2024
2.1.0-beta-0011 114 10/18/2024
2.1.0-beta-0010 108 10/18/2024
2.1.0-beta-0004 80 10/8/2024
2.1.0-beta-0002 81 10/6/2024
2.0.2 109 10/6/2024
2.0.1 106 10/6/2024
2.0.0 105 10/4/2024
2.0.0-beta-0060 82 10/6/2024
2.0.0-beta-0059 80 10/6/2024
2.0.0-beta-0056 77 10/4/2024
2.0.0-beta-0054 91 10/3/2024
2.0.0-beta-0053 80 10/2/2024
2.0.0-beta-0052 90 10/2/2024
2.0.0-beta-0050 92 10/2/2024
2.0.0-beta-0049 82 10/2/2024
2.0.0-beta-0046 84 10/1/2024
2.0.0-beta-0044 88 9/30/2024
2.0.0-beta-0026 92 9/24/2024
2.0.0-beta-0023 77 9/23/2024
2.0.0-beta-0022 66 9/23/2024
2.0.0-beta-0020 76 9/22/2024
2.0.0-beta-0004 69 9/20/2024
2.0.0-beta-0003 87 9/20/2024
1.9.0-beta-0003 85 9/16/2024
1.9.0-beta-0001 78 9/15/2024
1.9.0-beta 82 9/15/2024
1.8.1 113 9/14/2024
1.8.1-beta-0006 80 9/14/2024
1.8.1-beta-0005 91 9/14/2024
1.8.1-beta-0004 83 9/14/2024
1.8.1-beta-0003 75 9/14/2024
1.8.1-beta-0002 99 9/14/2024
1.8.1-beta-0001 78 9/14/2024
1.8.0 146 9/12/2024
1.8.0-beta-0064 95 9/12/2024
1.8.0-beta-0063 106 9/12/2024
1.8.0-beta-0059 80 9/8/2024
1.8.0-beta-0058 87 9/8/2024
1.8.0-beta-0057 96 9/8/2024
1.8.0-beta-0054 103 9/7/2024
1.8.0-beta-0053 95 9/6/2024
1.8.0-beta-0052 95 9/6/2024
1.8.0-beta-0051 106 9/6/2024
1.8.0-beta-0044 109 9/5/2024
1.8.0-beta-0042 93 9/4/2024
1.8.0-beta-0041 81 9/4/2024
1.8.0-beta-0027 115 8/25/2024
1.8.0-beta-0022 106 8/23/2024
1.8.0-beta-0017 83 8/7/2024
1.8.0-beta-0012 76 7/28/2024
1.8.0-beta-0010 82 7/28/2024
1.7.5 137 8/23/2024
1.7.4 130 8/9/2024
1.7.3 106 8/7/2024
1.7.2 95 7/28/2024
1.7.1 83 7/28/2024
1.7.0 134 7/20/2024
1.7.0-beta-0005 102 7/20/2024
1.7.0-beta-0001 94 7/8/2024
1.6.0 122 7/8/2024
1.6.0-beta-0004 98 7/7/2024
1.5.0 117 7/6/2024
1.5.0-beta-0010 103 7/6/2024
1.5.0-beta-0006 101 7/4/2024
1.4.5 128 7/4/2024
1.4.2 122 6/30/2024
1.4.1 122 6/30/2024
1.4.0 114 6/30/2024
1.4.0-beta-0010 101 6/30/2024
1.3.1 126 6/29/2024
1.3.0 119 6/29/2024
1.3.0-beta-0014 104 6/29/2024
1.3.0-beta-0007 90 6/26/2024
1.2.0 127 6/20/2024
1.2.0-beta-0001 105 6/20/2024
1.1.0 117 6/17/2024
1.1.0-beta-0019 97 6/20/2024
1.1.0-beta-0016 105 6/19/2024
1.1.0-beta-0014 106 6/17/2024
1.1.0-beta-0013 99 6/17/2024
1.0.0 128 6/15/2024
1.0.0-alpha-0054 103 6/15/2024
1.0.0-alpha-0053 99 6/12/2024
1.0.0-alpha-0051 100 6/12/2024
1.0.0-alpha-0048 110 6/10/2024
1.0.0-alpha-0047 98 6/10/2024
1.0.0-alpha-0043 104 6/9/2024
1.0.0-alpha-0042 111 6/7/2024
1.0.0-alpha-0040 107 6/6/2024
1.0.0-alpha-0038 105 6/6/2024
1.0.0-alpha-0036 108 6/5/2024
1.0.0-alpha-0034 113 6/4/2024
1.0.0-alpha-0031 103 6/4/2024
1.0.0-alpha-0025 105 6/3/2024
1.0.0-alpha-0023 104 6/2/2024
1.0.0-alpha-0022 105 6/1/2024
1.0.0-alpha-0019 106 6/1/2024
1.0.0-alpha-0018 106 6/1/2024
1.0.0-alpha-0014 117 6/1/2024
1.0.0-alpha-0013 99 6/1/2024
1.0.0-alpha-0012 99 5/31/2024
1.0.0-alpha-0011 107 5/31/2024
1.0.0-alpha-0010 109 5/31/2024