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.
#:package Shiny.Mediator.Blazor@1.0.0-alpha-0012
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Shiny.Mediator.Blazor&version=1.0.0-alpha-0012&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator.Blazor&version=1.0.0-alpha-0012&prerelease
                    
Install 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.10.0-beta-0005 44 8/22/2025
4.10.0-beta-0004 80 8/22/2025
4.10.0-beta-0003 83 8/18/2025
4.10.0-beta-0002 83 8/18/2025
4.10.0-beta-0001 92 7/29/2025
4.9.1 98 7/29/2025
4.9.0 205 7/26/2025
4.9.0-beta-0005 491 7/22/2025
4.9.0-beta-0004 492 7/22/2025
4.9.0-beta-0003 488 7/22/2025
4.9.0-beta-0002 436 7/21/2025
4.9.0-beta-0001 361 7/21/2025
4.8.0 42 7/18/2025
4.8.0-beta-0004 42 7/18/2025
4.8.0-beta-0003 141 7/14/2025
4.8.0-beta-0002 134 7/14/2025
4.8.0-beta-0001 132 7/14/2025
4.7.0 151 6/25/2025
4.7.0-beta-0026 128 7/13/2025
4.7.0-beta-0025 132 7/10/2025
4.7.0-beta-0023 143 6/25/2025
4.7.0-beta-0022 136 6/24/2025
4.7.0-beta-0021 144 6/23/2025
4.7.0-beta-0020 141 6/19/2025
4.7.0-beta-0004 133 6/19/2025
4.6.6 145 6/19/2025
4.6.5 138 6/19/2025
4.6.4 139 6/19/2025
4.6.3 142 6/18/2025
4.6.2 139 6/18/2025
4.6.1 152 6/16/2025
4.6.1-beta-0005 140 6/18/2025
4.6.1-beta-0003 138 6/18/2025
4.6.1-beta-0001 136 6/16/2025
4.6.0 144 6/16/2025
4.5.0 298 6/10/2025
4.5.0-beta-0007 281 6/10/2025
4.5.0-beta-0006 267 6/9/2025
4.5.0-beta-0004 96 6/6/2025
4.5.0-beta-0002 130 6/6/2025
4.4.0 152 6/3/2025
4.4.0-beta-0025 150 6/3/2025
4.4.0-beta-0023 151 5/29/2025
4.4.0-beta-0021 146 5/29/2025
4.4.0-beta-0018 148 5/26/2025
4.4.0-beta-0017 146 5/26/2025
4.4.0-beta-0015 141 5/26/2025
4.4.0-beta-0014 143 5/26/2025
4.4.0-beta-0004 99 5/25/2025
4.2.2 81 5/24/2025
4.2.1 180 5/8/2025
4.2.0 111 4/25/2025
4.2.0-beta-0010 154 5/8/2025
4.2.0-beta-0009 143 5/8/2025
4.2.0-beta-0008 104 4/25/2025
4.2.0-beta-0001 187 4/16/2025
4.1.0 166 3/28/2025
4.1.0-beta-0001 144 3/28/2025
4.0.4 421 3/24/2025
4.0.4-beta-0001 399 3/24/2025
4.0.3 280 3/23/2025
4.0.3-beta-0007 268 3/23/2025
4.0.2 88 3/15/2025
4.0.1 222 3/5/2025
4.0.1-beta-0010 156 3/19/2025
4.0.1-beta-0009 73 3/15/2025
4.0.1-beta-0001 209 3/5/2025
4.0.0 217 3/4/2025
4.0.0-beta-0021 208 3/4/2025
4.0.0-beta-0017 213 3/4/2025
4.0.0-beta-0016 206 3/4/2025
4.0.0-beta-0010 97 3/2/2025
4.0.0-beta-0009 94 3/2/2025
4.0.0-beta-0002 96 3/1/2025
3.3.1 125 2/20/2025
3.3.0 113 2/20/2025
3.3.0-beta-0028 101 2/20/2025
3.3.0-beta-0025 97 2/19/2025
3.3.0-beta-0024 100 2/19/2025
3.3.0-beta-0004 101 2/8/2025
3.2.0 106 1/29/2025
3.2.0-beta-0027 89 1/29/2025
3.2.0-beta-0023 89 1/29/2025
3.2.0-beta-0020 94 1/29/2025
3.1.3 103 1/29/2025
3.1.2 102 1/28/2025
3.1.1 111 1/25/2025
3.1.0 102 1/25/2025
3.1.0-beta-0013 90 1/25/2025
3.1.0-beta-0006 93 1/25/2025
3.1.0-beta-0004 89 1/25/2025
3.0.0 103 1/24/2025
3.0.0-beta-0055 94 1/24/2025
3.0.0-beta-0046 91 1/23/2025
3.0.0-beta-0045 86 1/23/2025
3.0.0-beta-0043 93 1/23/2025
3.0.0-beta-0038 94 1/21/2025
3.0.0-beta-0037 104 1/21/2025
3.0.0-beta-0029 103 1/21/2025
3.0.0-beta-0028 94 1/21/2025
3.0.0-beta-0018 84 1/19/2025
3.0.0-beta-0016 73 1/14/2025
3.0.0-beta-0012 102 1/12/2025
3.0.0-beta-0008 96 1/2/2025
3.0.0-beta-0007 96 12/28/2024
3.0.0-beta-0004 107 12/22/2024
2.2.0-beta-0001 100 10/28/2024
2.1.1 133 10/28/2024
2.1.0 130 10/19/2024
2.1.0-beta-0016 96 10/19/2024
2.1.0-beta-0015 92 10/19/2024
2.1.0-beta-0014 106 10/19/2024
2.1.0-beta-0013 116 10/19/2024
2.1.0-beta-0011 134 10/18/2024
2.1.0-beta-0010 127 10/18/2024
2.1.0-beta-0004 97 10/8/2024
2.1.0-beta-0002 94 10/6/2024
2.0.2 128 10/6/2024
2.0.1 121 10/6/2024
2.0.0 121 10/4/2024
2.0.0-beta-0060 96 10/6/2024
2.0.0-beta-0059 97 10/6/2024
2.0.0-beta-0056 94 10/4/2024
2.0.0-beta-0054 109 10/3/2024
2.0.0-beta-0053 104 10/2/2024
2.0.0-beta-0052 113 10/2/2024
2.0.0-beta-0050 103 10/2/2024
2.0.0-beta-0049 101 10/2/2024
2.0.0-beta-0046 103 10/1/2024
2.0.0-beta-0044 104 9/30/2024
2.0.0-beta-0026 104 9/24/2024
2.0.0-beta-0023 93 9/23/2024
2.0.0-beta-0022 83 9/23/2024
2.0.0-beta-0020 96 9/22/2024
2.0.0-beta-0004 87 9/20/2024
2.0.0-beta-0003 103 9/20/2024
1.9.0-beta-0003 100 9/16/2024
1.9.0-beta-0001 97 9/15/2024
1.9.0-beta 96 9/15/2024
1.8.1 129 9/14/2024
1.8.1-beta-0006 93 9/14/2024
1.8.1-beta-0005 111 9/14/2024
1.8.1-beta-0004 93 9/14/2024
1.8.1-beta-0003 93 9/14/2024
1.8.1-beta-0002 121 9/14/2024
1.8.1-beta-0001 92 9/14/2024
1.8.0 161 9/12/2024
1.8.0-beta-0064 106 9/12/2024
1.8.0-beta-0063 119 9/12/2024
1.8.0-beta-0059 92 9/8/2024
1.8.0-beta-0058 105 9/8/2024
1.8.0-beta-0057 111 9/8/2024
1.8.0-beta-0054 112 9/7/2024
1.8.0-beta-0053 112 9/6/2024
1.8.0-beta-0052 105 9/6/2024
1.8.0-beta-0051 117 9/6/2024
1.8.0-beta-0044 123 9/5/2024
1.8.0-beta-0042 102 9/4/2024
1.8.0-beta-0041 96 9/4/2024
1.8.0-beta-0027 132 8/25/2024
1.8.0-beta-0022 119 8/23/2024
1.8.0-beta-0017 104 8/7/2024
1.8.0-beta-0012 90 7/28/2024
1.8.0-beta-0010 101 7/28/2024
1.7.5 153 8/23/2024
1.7.4 143 8/9/2024
1.7.3 131 8/7/2024
1.7.2 104 7/28/2024
1.7.1 99 7/28/2024
1.7.0 147 7/20/2024
1.7.0-beta-0005 120 7/20/2024
1.7.0-beta-0001 108 7/8/2024
1.6.0 138 7/8/2024
1.6.0-beta-0004 111 7/7/2024
1.5.0 127 7/6/2024
1.5.0-beta-0010 123 7/6/2024
1.5.0-beta-0006 111 7/4/2024
1.4.5 142 7/4/2024
1.4.2 141 6/30/2024
1.4.1 144 6/30/2024
1.4.0 127 6/30/2024
1.4.0-beta-0010 123 6/30/2024
1.3.1 135 6/29/2024
1.3.0 136 6/29/2024
1.3.0-beta-0014 117 6/29/2024
1.3.0-beta-0007 106 6/26/2024
1.2.0 144 6/20/2024
1.2.0-beta-0001 114 6/20/2024
1.1.0 132 6/17/2024
1.1.0-beta-0019 112 6/20/2024
1.1.0-beta-0016 115 6/19/2024
1.1.0-beta-0014 125 6/17/2024
1.1.0-beta-0013 113 6/17/2024
1.0.0 147 6/15/2024
1.0.0-alpha-0054 120 6/15/2024
1.0.0-alpha-0053 114 6/12/2024
1.0.0-alpha-0051 112 6/12/2024
1.0.0-alpha-0048 120 6/10/2024
1.0.0-alpha-0047 112 6/10/2024
1.0.0-alpha-0043 122 6/9/2024
1.0.0-alpha-0042 124 6/7/2024
1.0.0-alpha-0040 124 6/6/2024
1.0.0-alpha-0038 122 6/6/2024
1.0.0-alpha-0036 120 6/5/2024
1.0.0-alpha-0034 134 6/4/2024
1.0.0-alpha-0031 116 6/4/2024
1.0.0-alpha-0025 121 6/3/2024
1.0.0-alpha-0023 120 6/2/2024
1.0.0-alpha-0022 119 6/1/2024
1.0.0-alpha-0019 124 6/1/2024
1.0.0-alpha-0018 119 6/1/2024
1.0.0-alpha-0014 132 6/1/2024
1.0.0-alpha-0013 113 6/1/2024
1.0.0-alpha-0012 116 5/31/2024
1.0.0-alpha-0011 120 5/31/2024
1.0.0-alpha-0010 123 5/31/2024