Shiny.Mediator.Blazor 1.0.0-alpha-0013

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-0013
                    
NuGet\Install-Package Shiny.Mediator.Blazor -Version 1.0.0-alpha-0013
                    
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-0013" />
                    
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-0013" />
                    
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-0013
                    
#r "nuget: Shiny.Mediator.Blazor, 1.0.0-alpha-0013"
                    
#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-0013
                    
#: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-0013&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator.Blazor&version=1.0.0-alpha-0013&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?includePreReleases=true" /> </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-0020 203 9/19/2025
4.10.0-beta-0019 271 9/18/2025
4.10.0-beta-0018 272 9/18/2025
4.10.0-beta-0017 277 9/18/2025
4.10.0-beta-0016 272 9/18/2025
4.10.0-beta-0015 276 9/18/2025
4.10.0-beta-0014 275 9/18/2025
4.10.0-beta-0013 274 9/18/2025
4.10.0-beta-0012 273 9/18/2025
4.10.0-beta-0011 281 9/16/2025
4.10.0-beta-0010 279 9/16/2025
4.10.0-beta-0009 146 9/10/2025
4.10.0-beta-0008 133 9/10/2025
4.10.0-beta-0007 148 9/9/2025
4.10.0-beta-0006 195 8/28/2025
4.10.0-beta-0005 106 8/22/2025
4.10.0-beta-0004 139 8/22/2025
4.10.0-beta-0003 133 8/18/2025
4.10.0-beta-0002 142 8/18/2025
4.10.0-beta-0001 105 7/29/2025
4.9.1 119 7/29/2025
4.9.0 222 7/26/2025
4.9.0-beta-0005 544 7/22/2025
4.9.0-beta-0004 542 7/22/2025
4.9.0-beta-0003 538 7/22/2025
4.9.0-beta-0002 488 7/21/2025
4.9.0-beta-0001 415 7/21/2025
4.8.0 90 7/18/2025
4.8.0-beta-0004 83 7/18/2025
4.8.0-beta-0003 160 7/14/2025
4.8.0-beta-0002 149 7/14/2025
4.8.0-beta-0001 147 7/14/2025
4.7.0 168 6/25/2025
4.7.0-beta-0026 143 7/13/2025
4.7.0-beta-0025 147 7/10/2025
4.7.0-beta-0023 156 6/25/2025
4.7.0-beta-0022 149 6/24/2025
4.7.0-beta-0021 164 6/23/2025
4.7.0-beta-0020 158 6/19/2025
4.7.0-beta-0004 152 6/19/2025
4.6.6 169 6/19/2025
4.6.5 151 6/19/2025
4.6.4 152 6/19/2025
4.6.3 155 6/18/2025
4.6.2 142 6/18/2025
4.6.1 160 6/16/2025
4.6.1-beta-0005 160 6/18/2025
4.6.1-beta-0003 146 6/18/2025
4.6.1-beta-0001 146 6/16/2025
4.6.0 163 6/16/2025
4.5.0 303 6/10/2025
4.5.0-beta-0007 301 6/10/2025
4.5.0-beta-0006 285 6/9/2025
4.5.0-beta-0004 99 6/6/2025
4.5.0-beta-0002 149 6/6/2025
4.4.0 170 6/3/2025
4.4.0-beta-0025 164 6/3/2025
4.4.0-beta-0023 171 5/29/2025
4.4.0-beta-0021 165 5/29/2025
4.4.0-beta-0018 163 5/26/2025
4.4.0-beta-0017 166 5/26/2025
4.4.0-beta-0015 159 5/26/2025
4.4.0-beta-0014 156 5/26/2025
4.4.0-beta-0004 115 5/25/2025
4.2.2 100 5/24/2025
4.2.1 200 5/8/2025
4.2.0 130 4/25/2025
4.2.0-beta-0010 161 5/8/2025
4.2.0-beta-0009 155 5/8/2025
4.2.0-beta-0008 127 4/25/2025
4.2.0-beta-0001 207 4/16/2025
4.1.0 179 3/28/2025
4.1.0-beta-0001 160 3/28/2025
4.0.4 437 3/24/2025
4.0.4-beta-0001 411 3/24/2025
4.0.3 295 3/23/2025
4.0.3-beta-0007 286 3/23/2025
4.0.2 108 3/15/2025
4.0.1 233 3/5/2025
4.0.1-beta-0010 174 3/19/2025
4.0.1-beta-0009 90 3/15/2025
4.0.1-beta-0001 223 3/5/2025
4.0.0 229 3/4/2025
4.0.0-beta-0021 224 3/4/2025
4.0.0-beta-0017 229 3/4/2025
4.0.0-beta-0016 207 3/4/2025
4.0.0-beta-0010 116 3/2/2025
4.0.0-beta-0009 111 3/2/2025
4.0.0-beta-0002 107 3/1/2025
3.3.1 142 2/20/2025
3.3.0 130 2/20/2025
3.3.0-beta-0028 105 2/20/2025
3.3.0-beta-0025 108 2/19/2025
3.3.0-beta-0024 111 2/19/2025
3.3.0-beta-0004 119 2/8/2025
3.2.0 122 1/29/2025
3.2.0-beta-0027 106 1/29/2025
3.2.0-beta-0023 102 1/29/2025
3.2.0-beta-0020 110 1/29/2025
3.1.3 119 1/29/2025
3.1.2 123 1/28/2025
3.1.1 130 1/25/2025
3.1.0 117 1/25/2025
3.1.0-beta-0013 101 1/25/2025
3.1.0-beta-0006 106 1/25/2025
3.1.0-beta-0004 107 1/25/2025
3.0.0 122 1/24/2025
3.0.0-beta-0055 114 1/24/2025
3.0.0-beta-0046 99 1/23/2025
3.0.0-beta-0045 97 1/23/2025
3.0.0-beta-0043 123 1/23/2025
3.0.0-beta-0038 106 1/21/2025
3.0.0-beta-0037 110 1/21/2025
3.0.0-beta-0029 119 1/21/2025
3.0.0-beta-0028 117 1/21/2025
3.0.0-beta-0018 95 1/19/2025
3.0.0-beta-0016 94 1/14/2025
3.0.0-beta-0012 120 1/12/2025
3.0.0-beta-0008 107 1/2/2025
3.0.0-beta-0007 111 12/28/2024
3.0.0-beta-0004 126 12/22/2024
2.2.0-beta-0001 111 10/28/2024
2.1.1 151 10/28/2024
2.1.0 142 10/19/2024
2.1.0-beta-0016 108 10/19/2024
2.1.0-beta-0015 103 10/19/2024
2.1.0-beta-0014 118 10/19/2024
2.1.0-beta-0013 127 10/19/2024
2.1.0-beta-0011 155 10/18/2024
2.1.0-beta-0010 142 10/18/2024
2.1.0-beta-0004 112 10/8/2024
2.1.0-beta-0002 105 10/6/2024
2.0.2 146 10/6/2024
2.0.1 140 10/6/2024
2.0.0 139 10/4/2024
2.0.0-beta-0060 107 10/6/2024
2.0.0-beta-0059 114 10/6/2024
2.0.0-beta-0056 113 10/4/2024
2.0.0-beta-0054 126 10/3/2024
2.0.0-beta-0053 123 10/2/2024
2.0.0-beta-0052 126 10/2/2024
2.0.0-beta-0050 114 10/2/2024
2.0.0-beta-0049 119 10/2/2024
2.0.0-beta-0046 118 10/1/2024
2.0.0-beta-0044 125 9/30/2024
2.0.0-beta-0026 116 9/24/2024
2.0.0-beta-0023 104 9/23/2024
2.0.0-beta-0022 100 9/23/2024
2.0.0-beta-0020 116 9/22/2024
2.0.0-beta-0004 104 9/20/2024
2.0.0-beta-0003 114 9/20/2024
1.9.0-beta-0003 116 9/16/2024
1.9.0-beta-0001 114 9/15/2024
1.9.0-beta 107 9/15/2024
1.8.1 137 9/14/2024
1.8.1-beta-0006 107 9/14/2024
1.8.1-beta-0005 117 9/14/2024
1.8.1-beta-0004 106 9/14/2024
1.8.1-beta-0003 97 9/14/2024
1.8.1-beta-0002 143 9/14/2024
1.8.1-beta-0001 100 9/14/2024
1.8.0 177 9/12/2024
1.8.0-beta-0064 117 9/12/2024
1.8.0-beta-0063 130 9/12/2024
1.8.0-beta-0059 103 9/8/2024
1.8.0-beta-0058 121 9/8/2024
1.8.0-beta-0057 124 9/8/2024
1.8.0-beta-0054 113 9/7/2024
1.8.0-beta-0053 126 9/6/2024
1.8.0-beta-0052 106 9/6/2024
1.8.0-beta-0051 137 9/6/2024
1.8.0-beta-0044 138 9/5/2024
1.8.0-beta-0042 113 9/4/2024
1.8.0-beta-0041 113 9/4/2024
1.8.0-beta-0027 137 8/25/2024
1.8.0-beta-0022 140 8/23/2024
1.8.0-beta-0017 108 8/7/2024
1.8.0-beta-0012 104 7/28/2024
1.8.0-beta-0010 123 7/28/2024
1.7.5 158 8/23/2024
1.7.4 162 8/9/2024
1.7.3 155 8/7/2024
1.7.2 115 7/28/2024
1.7.1 117 7/28/2024
1.7.0 167 7/20/2024
1.7.0-beta-0005 129 7/20/2024
1.7.0-beta-0001 110 7/8/2024
1.6.0 154 7/8/2024
1.6.0-beta-0004 132 7/7/2024
1.5.0 139 7/6/2024
1.5.0-beta-0010 141 7/6/2024
1.5.0-beta-0006 124 7/4/2024
1.4.5 154 7/4/2024
1.4.2 159 6/30/2024
1.4.1 151 6/30/2024
1.4.0 139 6/30/2024
1.4.0-beta-0010 141 6/30/2024
1.3.1 136 6/29/2024
1.3.0 148 6/29/2024
1.3.0-beta-0014 128 6/29/2024
1.3.0-beta-0007 123 6/26/2024
1.2.0 160 6/20/2024
1.2.0-beta-0001 125 6/20/2024
1.1.0 148 6/17/2024
1.1.0-beta-0019 130 6/20/2024
1.1.0-beta-0016 126 6/19/2024
1.1.0-beta-0014 135 6/17/2024
1.1.0-beta-0013 131 6/17/2024
1.0.0 160 6/15/2024
1.0.0-alpha-0054 136 6/15/2024
1.0.0-alpha-0053 119 6/12/2024
1.0.0-alpha-0051 125 6/12/2024
1.0.0-alpha-0048 133 6/10/2024
1.0.0-alpha-0047 123 6/10/2024
1.0.0-alpha-0043 141 6/9/2024
1.0.0-alpha-0042 155 6/7/2024
1.0.0-alpha-0040 144 6/6/2024
1.0.0-alpha-0038 143 6/6/2024
1.0.0-alpha-0036 134 6/5/2024
1.0.0-alpha-0034 155 6/4/2024
1.0.0-alpha-0031 117 6/4/2024
1.0.0-alpha-0025 138 6/3/2024
1.0.0-alpha-0023 141 6/2/2024
1.0.0-alpha-0022 139 6/1/2024
1.0.0-alpha-0019 144 6/1/2024
1.0.0-alpha-0018 136 6/1/2024
1.0.0-alpha-0014 153 6/1/2024
1.0.0-alpha-0013 128 6/1/2024
1.0.0-alpha-0012 131 5/31/2024
1.0.0-alpha-0011 131 5/31/2024
1.0.0-alpha-0010 134 5/31/2024