Shiny.Mediator 1.0.0-alpha-0025

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-0025
                    
NuGet\Install-Package Shiny.Mediator -Version 1.0.0-alpha-0025
                    
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-0025" />
                    
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-0025" />
                    
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-0025
                    
#r "nuget: Shiny.Mediator, 1.0.0-alpha-0025"
                    
#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-0025
                    
#: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-0025&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator&version=1.0.0-alpha-0025&prerelease
                    
Install as a Cake Tool

Shiny Mediator (Preview)

PLEASE NOTE - THIS IS AN ALPHA. THINGS ARE LIKELY TO CHANGE

<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.

This project is heavily inspired by MediatR with some lesser features that we feel were aimed more at server scenarios, while also adding some features we feel benefit apps

Features

  • A Mediator for your .NET Apps (MAUI & Blazor are the main targets for us)
  • Think of "weak" message subscriptions without the fuss or mess to cleanup
  • 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! (WIP)
  • 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
        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

First, let's install Shiny.Mediator.Maui Now...let's go back to our 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)
    {
    }
}

Request Middleware

TODO

Event Covariance

TODO

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!

Request Middleware Ideas

  • Connectivity check - pull from cache/memory or go to the API

TODO

  • Explain Event Collectors
  • Event Collectors for MAUI execute on main thread?
  • Streams - IAsyncEnumerable or IObservable
  • Source Generator Registration
    • Need to use a different method or not use extension methods - maybe AddHandlersFromAssemblyName or allow it to be custom named
  • IEventHandler<IEvent> can handle ALL events?
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-0020 302 9/19/2025
4.10.0-beta-0019 363 9/18/2025
4.10.0-beta-0018 357 9/18/2025
4.10.0-beta-0017 363 9/18/2025
4.10.0-beta-0016 361 9/18/2025
4.10.0-beta-0015 354 9/18/2025
4.10.0-beta-0014 361 9/18/2025
4.10.0-beta-0013 361 9/18/2025
4.10.0-beta-0012 354 9/18/2025
4.10.0-beta-0011 344 9/16/2025
4.10.0-beta-0010 359 9/16/2025
4.10.0-beta-0009 225 9/10/2025
4.10.0-beta-0008 202 9/10/2025
4.10.0-beta-0007 202 9/9/2025
4.10.0-beta-0006 276 8/28/2025
4.10.0-beta-0005 171 8/22/2025
4.10.0-beta-0004 195 8/22/2025
4.10.0-beta-0003 207 8/18/2025
4.10.0-beta-0002 201 8/18/2025
4.10.0-beta-0001 162 7/29/2025
4.9.1 678 7/29/2025
4.9.0 278 7/26/2025
4.9.0-beta-0005 611 7/22/2025
4.9.0-beta-0004 610 7/22/2025
4.9.0-beta-0003 607 7/22/2025
4.9.0-beta-0002 570 7/21/2025
4.9.0-beta-0001 496 7/21/2025
4.8.0 334 7/18/2025
4.8.0-beta-0004 164 7/18/2025
4.8.0-beta-0003 240 7/14/2025
4.8.0-beta-0002 224 7/14/2025
4.8.0-beta-0001 219 7/14/2025
4.7.0 488 6/25/2025
4.7.0-beta-0026 215 7/13/2025
4.7.0-beta-0025 215 7/10/2025
4.7.0-beta-0024 154 6/25/2025
4.7.0-beta-0023 226 6/25/2025
4.7.0-beta-0022 224 6/24/2025
4.7.0-beta-0021 235 6/23/2025
4.7.0-beta-0020 228 6/19/2025
4.7.0-beta-0004 233 6/19/2025
4.6.6 257 6/19/2025
4.6.5 233 6/19/2025
4.6.4 231 6/19/2025
4.6.3 546 6/18/2025
4.6.2 244 6/18/2025
4.6.1 270 6/16/2025
4.6.1-beta-0005 230 6/18/2025
4.6.1-beta-0003 217 6/18/2025
4.6.1-beta-0001 230 6/16/2025
4.6.0 246 6/16/2025
4.5.0 441 6/10/2025
4.5.0-beta-0007 376 6/10/2025
4.5.0-beta-0006 343 6/9/2025
4.5.0-beta-0004 192 6/6/2025
4.5.0-beta-0002 225 6/6/2025
4.4.0 487 6/3/2025
4.4.0-beta-0025 232 6/3/2025
4.4.0-beta-0023 227 5/29/2025
4.4.0-beta-0021 237 5/29/2025
4.4.0-beta-0018 239 5/26/2025
4.4.0-beta-0017 243 5/26/2025
4.4.0-beta-0015 224 5/26/2025
4.4.0-beta-0014 220 5/26/2025
4.4.0-beta-0004 204 5/25/2025
4.2.2 533 5/24/2025
4.2.1 416 5/8/2025
4.2.0 378 4/25/2025
4.2.0-beta-0010 253 5/8/2025
4.2.0-beta-0009 249 5/8/2025
4.2.0-beta-0008 219 4/25/2025
4.2.0-beta-0001 299 4/16/2025
4.1.0 563 3/28/2025
4.1.0-beta-0001 240 3/28/2025
4.0.4 544 3/24/2025
4.0.4-beta-0001 518 3/24/2025
4.0.3 367 3/23/2025
4.0.3-beta-0007 358 3/23/2025
4.0.2 344 3/15/2025
4.0.1 486 3/5/2025
4.0.1-beta-0010 261 3/19/2025
4.0.1-beta-0009 163 3/15/2025
4.0.1-beta-0001 325 3/5/2025
4.0.0 330 3/4/2025
4.0.0-beta-0021 319 3/4/2025
4.0.0-beta-0017 315 3/4/2025
4.0.0-beta-0016 314 3/4/2025
4.0.0-beta-0010 196 3/2/2025
4.0.0-beta-0009 192 3/2/2025
4.0.0-beta-0002 220 3/1/2025
3.3.1 381 2/20/2025
3.3.0 210 2/20/2025
3.3.0-beta-0028 181 2/20/2025
3.3.0-beta-0025 224 2/19/2025
3.3.0-beta-0024 251 2/19/2025
3.3.0-beta-0004 191 2/8/2025
3.2.0 478 1/29/2025
3.2.0-beta-0027 184 1/29/2025
3.2.0-beta-0023 184 1/29/2025
3.2.0-beta-0020 192 1/29/2025
3.1.3 187 1/29/2025
3.1.2 204 1/28/2025
3.1.1 217 1/25/2025
3.1.0 186 1/25/2025
3.1.0-beta-0013 187 1/25/2025
3.1.0-beta-0006 172 1/25/2025
3.1.0-beta-0004 171 1/25/2025
3.0.0 185 1/24/2025
3.0.0-beta-0055 193 1/24/2025
3.0.0-beta-0046 183 1/23/2025
3.0.0-beta-0045 178 1/23/2025
3.0.0-beta-0043 205 1/23/2025
3.0.0-beta-0038 205 1/21/2025
3.0.0-beta-0037 180 1/21/2025
3.0.0-beta-0029 195 1/21/2025
3.0.0-beta-0028 193 1/21/2025
3.0.0-beta-0018 177 1/19/2025
3.0.0-beta-0016 174 1/14/2025
3.0.0-beta-0012 180 1/12/2025
3.0.0-beta-0008 205 1/2/2025
3.0.0-beta-0007 179 12/28/2024
3.0.0-beta-0004 164 12/22/2024
2.2.0-beta-0001 405 10/28/2024
2.1.1 834 10/28/2024
2.1.0 338 10/19/2024
2.1.0-beta-0016 187 10/19/2024
2.1.0-beta-0015 196 10/19/2024
2.1.0-beta-0014 212 10/19/2024
2.1.0-beta-0013 212 10/19/2024
2.1.0-beta-0011 215 10/18/2024
2.1.0-beta-0010 199 10/18/2024
2.1.0-beta-0004 203 10/8/2024
2.1.0-beta-0002 189 10/6/2024
2.0.2 462 10/6/2024
2.0.1 211 10/6/2024
2.0.0 304 10/4/2024
2.0.0-beta-0060 194 10/6/2024
2.0.0-beta-0059 181 10/6/2024
2.0.0-beta-0056 195 10/4/2024
2.0.0-beta-0054 195 10/3/2024
2.0.0-beta-0053 195 10/2/2024
2.0.0-beta-0052 200 10/2/2024
2.0.0-beta-0050 187 10/2/2024
2.0.0-beta-0049 201 10/2/2024
2.0.0-beta-0046 210 10/1/2024
2.0.0-beta-0044 204 9/30/2024
2.0.0-beta-0026 198 9/24/2024
2.0.0-beta-0023 199 9/23/2024
2.0.0-beta-0022 174 9/23/2024
2.0.0-beta-0020 175 9/22/2024
2.0.0-beta-0004 166 9/20/2024
2.0.0-beta-0003 194 9/20/2024
1.9.0-beta-0003 200 9/16/2024
1.9.0-beta-0001 199 9/15/2024
1.9.0-beta 206 9/15/2024
1.8.1 388 9/14/2024
1.8.1-beta-0006 200 9/14/2024
1.8.1-beta-0005 171 9/14/2024
1.8.1-beta-0004 200 9/14/2024
1.8.1-beta-0003 185 9/14/2024
1.8.1-beta-0002 192 9/14/2024
1.8.1-beta-0001 187 9/14/2024
1.8.0 258 9/12/2024
1.8.0-beta-0064 204 9/12/2024
1.8.0-beta-0063 212 9/12/2024
1.8.0-beta-0059 204 9/8/2024
1.8.0-beta-0058 193 9/8/2024
1.8.0-beta-0057 219 9/8/2024
1.8.0-beta-0054 214 9/7/2024
1.8.0-beta-0053 225 9/6/2024
1.8.0-beta-0052 210 9/6/2024
1.8.0-beta-0051 207 9/6/2024
1.8.0-beta-0044 232 9/5/2024
1.8.0-beta-0042 216 9/4/2024
1.8.0-beta-0041 207 9/4/2024
1.8.0-beta-0027 226 8/25/2024
1.8.0-beta-0022 214 8/23/2024
1.8.0-beta-0017 215 8/7/2024
1.8.0-beta-0012 166 7/28/2024
1.8.0-beta-0010 137 7/28/2024
1.7.5 266 8/23/2024
1.7.4 374 8/9/2024
1.7.3 225 8/7/2024
1.7.2 200 7/28/2024
1.7.1 158 7/28/2024
1.7.0 237 7/20/2024
1.7.0-beta-0005 163 7/20/2024
1.7.0-beta-0001 183 7/8/2024
1.6.0 231 7/8/2024
1.6.0-beta-0004 178 7/7/2024
1.5.0 202 7/6/2024
1.5.0-beta-0010 188 7/6/2024
1.5.0-beta-0006 185 7/4/2024
1.4.5 186 7/4/2024
1.4.2 215 6/30/2024
1.4.1 212 6/30/2024
1.4.0 211 6/30/2024
1.4.0-beta-0010 207 6/30/2024
1.3.1 217 6/29/2024
1.3.0 198 6/29/2024
1.3.0-beta-0014 178 6/29/2024
1.3.0-beta-0007 168 6/26/2024
1.2.0 201 6/20/2024
1.2.0-beta-0001 159 6/20/2024
1.1.0 201 6/17/2024
1.1.0-beta-0019 174 6/20/2024
1.1.0-beta-0016 180 6/19/2024
1.1.0-beta-0014 158 6/17/2024
1.1.0-beta-0013 175 6/17/2024
1.0.0 232 6/15/2024
1.0.0-alpha-0054 158 6/15/2024
1.0.0-alpha-0053 177 6/12/2024
1.0.0-alpha-0051 150 6/12/2024
1.0.0-alpha-0048 168 6/10/2024
1.0.0-alpha-0047 162 6/10/2024
1.0.0-alpha-0043 144 6/9/2024
1.0.0-alpha-0042 207 6/7/2024
1.0.0-alpha-0040 176 6/6/2024
1.0.0-alpha-0038 163 6/6/2024
1.0.0-alpha-0036 162 6/5/2024
1.0.0-alpha-0034 168 6/4/2024
1.0.0-alpha-0031 145 6/4/2024
1.0.0-alpha-0025 145 6/3/2024
1.0.0-alpha-0023 178 6/2/2024
1.0.0-alpha-0022 168 6/1/2024
1.0.0-alpha-0019 171 6/1/2024
1.0.0-alpha-0018 155 6/1/2024
1.0.0-alpha-0014 158 6/1/2024
1.0.0-alpha-0013 153 6/1/2024
1.0.0-alpha-0012 157 5/31/2024
1.0.0-alpha-0011 146 5/31/2024
1.0.0-alpha-0010 134 5/31/2024