Shiny.Mediator 1.0.0-alpha-0018

Prefix Reserved
This is a prerelease version of Shiny.Mediator.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator --version 1.0.0-alpha-0018
                    
NuGet\Install-Package Shiny.Mediator -Version 1.0.0-alpha-0018
                    
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" Version="1.0.0-alpha-0018" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shiny.Mediator" Version="1.0.0-alpha-0018" />
                    
Directory.Packages.props
<PackageReference Include="Shiny.Mediator" />
                    
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 --version 1.0.0-alpha-0018
                    
#r "nuget: Shiny.Mediator, 1.0.0-alpha-0018"
                    
#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@1.0.0-alpha-0018
                    
#: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&version=1.0.0-alpha-0018&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator&version=1.0.0-alpha-0018&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

Install Shiny.Mediator from NuGet

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 (12)

Showing the top 5 NuGet packages that depend on Shiny.Mediator:

Package Downloads
Shiny.Mediator.Maui

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Blazor

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Resilience

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Prism

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.AspNet

Shiny Mediator - A mediator pattern for all .NET Apps

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.10.0-beta-0006 222 8/28/2025
4.10.0-beta-0005 114 8/22/2025
4.10.0-beta-0004 145 8/22/2025
4.10.0-beta-0003 153 8/18/2025
4.10.0-beta-0002 149 8/18/2025
4.10.0-beta-0001 121 7/29/2025
4.9.1 424 7/29/2025
4.9.0 212 7/26/2025
4.9.0-beta-0005 491 7/22/2025
4.9.0-beta-0004 494 7/22/2025
4.9.0-beta-0003 491 7/22/2025
4.9.0-beta-0002 461 7/21/2025
4.9.0-beta-0001 385 7/21/2025
4.8.0 185 7/18/2025
4.8.0-beta-0004 70 7/18/2025
4.8.0-beta-0003 204 7/14/2025
4.8.0-beta-0002 183 7/14/2025
4.8.0-beta-0001 179 7/14/2025
4.7.0 440 6/25/2025
4.7.0-beta-0026 178 7/13/2025
4.7.0-beta-0025 182 7/10/2025
4.7.0-beta-0024 140 6/25/2025
4.7.0-beta-0023 186 6/25/2025
4.7.0-beta-0022 188 6/24/2025
4.7.0-beta-0021 191 6/23/2025
4.7.0-beta-0020 189 6/19/2025
4.7.0-beta-0004 189 6/19/2025
4.6.6 199 6/19/2025
4.6.5 192 6/19/2025
4.6.4 189 6/19/2025
4.6.3 445 6/18/2025
4.6.2 204 6/18/2025
4.6.1 224 6/16/2025
4.6.1-beta-0005 194 6/18/2025
4.6.1-beta-0003 192 6/18/2025
4.6.1-beta-0001 188 6/16/2025
4.6.0 198 6/16/2025
4.5.0 404 6/10/2025
4.5.0-beta-0007 338 6/10/2025
4.5.0-beta-0006 309 6/9/2025
4.5.0-beta-0004 146 6/6/2025
4.5.0-beta-0002 182 6/6/2025
4.4.0 437 6/3/2025
4.4.0-beta-0025 185 6/3/2025
4.4.0-beta-0023 190 5/29/2025
4.4.0-beta-0021 192 5/29/2025
4.4.0-beta-0018 198 5/26/2025
4.4.0-beta-0017 199 5/26/2025
4.4.0-beta-0015 188 5/26/2025
4.4.0-beta-0014 195 5/26/2025
4.4.0-beta-0004 153 5/25/2025
4.2.2 477 5/24/2025
4.2.1 366 5/8/2025
4.2.0 333 4/25/2025
4.2.0-beta-0010 208 5/8/2025
4.2.0-beta-0009 204 5/8/2025
4.2.0-beta-0008 169 4/25/2025
4.2.0-beta-0001 261 4/16/2025
4.1.0 518 3/28/2025
4.1.0-beta-0001 191 3/28/2025
4.0.4 497 3/24/2025
4.0.4-beta-0001 466 3/24/2025
4.0.3 324 3/23/2025
4.0.3-beta-0007 316 3/23/2025
4.0.2 297 3/15/2025
4.0.1 438 3/5/2025
4.0.1-beta-0010 211 3/19/2025
4.0.1-beta-0009 132 3/15/2025
4.0.1-beta-0001 287 3/5/2025
4.0.0 286 3/4/2025
4.0.0-beta-0021 273 3/4/2025
4.0.0-beta-0017 269 3/4/2025
4.0.0-beta-0016 278 3/4/2025
4.0.0-beta-0010 154 3/2/2025
4.0.0-beta-0009 151 3/2/2025
4.0.0-beta-0002 167 3/1/2025
3.3.1 343 2/20/2025
3.3.0 166 2/20/2025
3.3.0-beta-0028 154 2/20/2025
3.3.0-beta-0025 177 2/19/2025
3.3.0-beta-0024 201 2/19/2025
3.3.0-beta-0004 150 2/8/2025
3.2.0 437 1/29/2025
3.2.0-beta-0027 141 1/29/2025
3.2.0-beta-0023 153 1/29/2025
3.2.0-beta-0020 147 1/29/2025
3.1.3 150 1/29/2025
3.1.2 162 1/28/2025
3.1.1 177 1/25/2025
3.1.0 152 1/25/2025
3.1.0-beta-0013 145 1/25/2025
3.1.0-beta-0006 137 1/25/2025
3.1.0-beta-0004 137 1/25/2025
3.0.0 147 1/24/2025
3.0.0-beta-0055 146 1/24/2025
3.0.0-beta-0046 144 1/23/2025
3.0.0-beta-0045 141 1/23/2025
3.0.0-beta-0043 160 1/23/2025
3.0.0-beta-0038 163 1/21/2025
3.0.0-beta-0037 146 1/21/2025
3.0.0-beta-0029 146 1/21/2025
3.0.0-beta-0028 153 1/21/2025
3.0.0-beta-0018 140 1/19/2025
3.0.0-beta-0016 119 1/14/2025
3.0.0-beta-0012 133 1/12/2025
3.0.0-beta-0008 161 1/2/2025
3.0.0-beta-0007 149 12/28/2024
3.0.0-beta-0004 137 12/22/2024
2.2.0-beta-0001 358 10/28/2024
2.1.1 778 10/28/2024
2.1.0 306 10/19/2024
2.1.0-beta-0016 153 10/19/2024
2.1.0-beta-0015 153 10/19/2024
2.1.0-beta-0014 172 10/19/2024
2.1.0-beta-0013 172 10/19/2024
2.1.0-beta-0011 177 10/18/2024
2.1.0-beta-0010 171 10/18/2024
2.1.0-beta-0004 161 10/8/2024
2.1.0-beta-0002 151 10/6/2024
2.0.2 428 10/6/2024
2.0.1 173 10/6/2024
2.0.0 263 10/4/2024
2.0.0-beta-0060 151 10/6/2024
2.0.0-beta-0059 143 10/6/2024
2.0.0-beta-0056 151 10/4/2024
2.0.0-beta-0054 152 10/3/2024
2.0.0-beta-0053 153 10/2/2024
2.0.0-beta-0052 159 10/2/2024
2.0.0-beta-0050 160 10/2/2024
2.0.0-beta-0049 159 10/2/2024
2.0.0-beta-0046 169 10/1/2024
2.0.0-beta-0044 160 9/30/2024
2.0.0-beta-0026 165 9/24/2024
2.0.0-beta-0023 152 9/23/2024
2.0.0-beta-0022 136 9/23/2024
2.0.0-beta-0020 141 9/22/2024
2.0.0-beta-0004 145 9/20/2024
2.0.0-beta-0003 160 9/20/2024
1.9.0-beta-0003 163 9/16/2024
1.9.0-beta-0001 163 9/15/2024
1.9.0-beta 167 9/15/2024
1.8.1 355 9/14/2024
1.8.1-beta-0006 161 9/14/2024
1.8.1-beta-0005 163 9/14/2024
1.8.1-beta-0004 161 9/14/2024
1.8.1-beta-0003 155 9/14/2024
1.8.1-beta-0002 160 9/14/2024
1.8.1-beta-0001 162 9/14/2024
1.8.0 225 9/12/2024
1.8.0-beta-0064 165 9/12/2024
1.8.0-beta-0063 177 9/12/2024
1.8.0-beta-0059 178 9/8/2024
1.8.0-beta-0058 159 9/8/2024
1.8.0-beta-0057 177 9/8/2024
1.8.0-beta-0054 184 9/7/2024
1.8.0-beta-0053 185 9/6/2024
1.8.0-beta-0052 175 9/6/2024
1.8.0-beta-0051 174 9/6/2024
1.8.0-beta-0044 195 9/5/2024
1.8.0-beta-0042 178 9/4/2024
1.8.0-beta-0041 175 9/4/2024
1.8.0-beta-0027 195 8/25/2024
1.8.0-beta-0022 185 8/23/2024
1.8.0-beta-0017 174 8/7/2024
1.8.0-beta-0012 125 7/28/2024
1.8.0-beta-0010 112 7/28/2024
1.7.5 241 8/23/2024
1.7.4 344 8/9/2024
1.7.3 194 8/7/2024
1.7.2 164 7/28/2024
1.7.1 134 7/28/2024
1.7.0 205 7/20/2024
1.7.0-beta-0005 137 7/20/2024
1.7.0-beta-0001 157 7/8/2024
1.6.0 200 7/8/2024
1.6.0-beta-0004 148 7/7/2024
1.5.0 181 7/6/2024
1.5.0-beta-0010 158 7/6/2024
1.5.0-beta-0006 156 7/4/2024
1.4.5 170 7/4/2024
1.4.2 181 6/30/2024
1.4.1 185 6/30/2024
1.4.0 180 6/30/2024
1.4.0-beta-0010 169 6/30/2024
1.3.1 191 6/29/2024
1.3.0 174 6/29/2024
1.3.0-beta-0014 155 6/29/2024
1.3.0-beta-0007 142 6/26/2024
1.2.0 175 6/20/2024
1.2.0-beta-0001 138 6/20/2024
1.1.0 179 6/17/2024
1.1.0-beta-0019 144 6/20/2024
1.1.0-beta-0016 156 6/19/2024
1.1.0-beta-0014 149 6/17/2024
1.1.0-beta-0013 153 6/17/2024
1.0.0 212 6/15/2024
1.0.0-alpha-0054 144 6/15/2024
1.0.0-alpha-0053 155 6/12/2024
1.0.0-alpha-0051 135 6/12/2024
1.0.0-alpha-0048 151 6/10/2024
1.0.0-alpha-0047 147 6/10/2024
1.0.0-alpha-0043 129 6/9/2024
1.0.0-alpha-0042 177 6/7/2024
1.0.0-alpha-0040 152 6/6/2024
1.0.0-alpha-0038 150 6/6/2024
1.0.0-alpha-0036 139 6/5/2024
1.0.0-alpha-0034 154 6/4/2024
1.0.0-alpha-0031 142 6/4/2024
1.0.0-alpha-0025 136 6/3/2024
1.0.0-alpha-0023 154 6/2/2024
1.0.0-alpha-0022 149 6/1/2024
1.0.0-alpha-0019 147 6/1/2024
1.0.0-alpha-0018 141 6/1/2024
1.0.0-alpha-0014 141 6/1/2024
1.0.0-alpha-0013 136 6/1/2024
1.0.0-alpha-0012 143 5/31/2024
1.0.0-alpha-0011 133 5/31/2024
1.0.0-alpha-0010 132 5/31/2024