Shiny.Mediator 1.0.0-alpha-0022

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

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

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!

Request Middleware Ideas

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

TODO

  • Explain Event Collectors
  • 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?
  • Request Middleware - Covariance/catch-all
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 (11)

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

Showing the top 1 popular GitHub repositories that depend on Shiny.Mediator:

Repository Stars
shinyorg/templates
dotnet CLI & Visual Studio Templates
Version Downloads Last updated
4.4.0-beta-0018 68 5/26/2025
4.4.0-beta-0017 76 5/26/2025
4.4.0-beta-0015 71 5/26/2025
4.4.0-beta-0014 80 5/26/2025
4.4.0-beta-0004 76 5/25/2025
4.2.2 174 5/24/2025
4.2.1 310 5/8/2025
4.2.0 304 4/25/2025
4.2.0-beta-0010 186 5/8/2025
4.2.0-beta-0009 184 5/8/2025
4.2.0-beta-0008 146 4/25/2025
4.2.0-beta-0001 237 4/16/2025
4.1.0 487 3/28/2025
4.1.0-beta-0001 169 3/28/2025
4.0.4 475 3/24/2025
4.0.4-beta-0001 442 3/24/2025
4.0.3 309 3/23/2025
4.0.3-beta-0007 303 3/23/2025
4.0.2 275 3/15/2025
4.0.1 420 3/5/2025
4.0.1-beta-0010 191 3/19/2025
4.0.1-beta-0009 112 3/15/2025
4.0.1-beta-0001 261 3/5/2025
4.0.0 265 3/4/2025
4.0.0-beta-0021 251 3/4/2025
4.0.0-beta-0017 248 3/4/2025
4.0.0-beta-0016 249 3/4/2025
4.0.0-beta-0010 139 3/2/2025
4.0.0-beta-0009 137 3/2/2025
4.0.0-beta-0002 142 3/1/2025
3.3.1 313 2/20/2025
3.3.0 152 2/20/2025
3.3.0-beta-0028 133 2/20/2025
3.3.0-beta-0025 160 2/19/2025
3.3.0-beta-0024 173 2/19/2025
3.3.0-beta-0004 127 2/8/2025
3.2.0 413 1/29/2025
3.2.0-beta-0027 122 1/29/2025
3.2.0-beta-0023 128 1/29/2025
3.2.0-beta-0020 125 1/29/2025
3.1.3 132 1/29/2025
3.1.2 137 1/28/2025
3.1.1 157 1/25/2025
3.1.0 131 1/25/2025
3.1.0-beta-0013 125 1/25/2025
3.1.0-beta-0006 119 1/25/2025
3.1.0-beta-0004 122 1/25/2025
3.0.0 125 1/24/2025
3.0.0-beta-0055 122 1/24/2025
3.0.0-beta-0046 118 1/23/2025
3.0.0-beta-0045 128 1/23/2025
3.0.0-beta-0043 140 1/23/2025
3.0.0-beta-0038 142 1/21/2025
3.0.0-beta-0037 121 1/21/2025
3.0.0-beta-0029 129 1/21/2025
3.0.0-beta-0028 130 1/21/2025
3.0.0-beta-0018 122 1/19/2025
3.0.0-beta-0016 94 1/14/2025
3.0.0-beta-0012 110 1/12/2025
3.0.0-beta-0008 141 1/2/2025
3.0.0-beta-0007 132 12/28/2024
3.0.0-beta-0004 126 12/22/2024
2.2.0-beta-0001 333 10/28/2024
2.1.1 719 10/28/2024
2.1.0 290 10/19/2024
2.1.0-beta-0016 138 10/19/2024
2.1.0-beta-0015 135 10/19/2024
2.1.0-beta-0014 152 10/19/2024
2.1.0-beta-0013 150 10/19/2024
2.1.0-beta-0011 164 10/18/2024
2.1.0-beta-0010 154 10/18/2024
2.1.0-beta-0004 133 10/8/2024
2.1.0-beta-0002 130 10/6/2024
2.0.2 411 10/6/2024
2.0.1 158 10/6/2024
2.0.0 230 10/4/2024
2.0.0-beta-0060 129 10/6/2024
2.0.0-beta-0059 124 10/6/2024
2.0.0-beta-0056 131 10/4/2024
2.0.0-beta-0054 137 10/3/2024
2.0.0-beta-0053 135 10/2/2024
2.0.0-beta-0052 139 10/2/2024
2.0.0-beta-0050 135 10/2/2024
2.0.0-beta-0049 140 10/2/2024
2.0.0-beta-0046 142 10/1/2024
2.0.0-beta-0044 135 9/30/2024
2.0.0-beta-0026 143 9/24/2024
2.0.0-beta-0023 131 9/23/2024
2.0.0-beta-0022 120 9/23/2024
2.0.0-beta-0020 127 9/22/2024
2.0.0-beta-0004 130 9/20/2024
2.0.0-beta-0003 140 9/20/2024
1.9.0-beta-0003 143 9/16/2024
1.9.0-beta-0001 145 9/15/2024
1.9.0-beta 143 9/15/2024
1.8.1 340 9/14/2024
1.8.1-beta-0006 137 9/14/2024
1.8.1-beta-0005 146 9/14/2024
1.8.1-beta-0004 141 9/14/2024
1.8.1-beta-0003 142 9/14/2024
1.8.1-beta-0002 140 9/14/2024
1.8.1-beta-0001 145 9/14/2024
1.8.0 204 9/12/2024
1.8.0-beta-0064 144 9/12/2024
1.8.0-beta-0063 164 9/12/2024
1.8.0-beta-0059 156 9/8/2024
1.8.0-beta-0058 143 9/8/2024
1.8.0-beta-0057 158 9/8/2024
1.8.0-beta-0054 171 9/7/2024
1.8.0-beta-0053 167 9/6/2024
1.8.0-beta-0052 156 9/6/2024
1.8.0-beta-0051 162 9/6/2024
1.8.0-beta-0044 167 9/5/2024
1.8.0-beta-0042 158 9/4/2024
1.8.0-beta-0041 152 9/4/2024
1.8.0-beta-0027 173 8/25/2024
1.8.0-beta-0022 172 8/23/2024
1.8.0-beta-0017 158 8/7/2024
1.8.0-beta-0012 108 7/28/2024
1.8.0-beta-0010 96 7/28/2024
1.7.5 220 8/23/2024
1.7.4 324 8/9/2024
1.7.3 175 8/7/2024
1.7.2 141 7/28/2024
1.7.1 117 7/28/2024
1.7.0 184 7/20/2024
1.7.0-beta-0005 125 7/20/2024
1.7.0-beta-0001 136 7/8/2024
1.6.0 181 7/8/2024
1.6.0-beta-0004 133 7/7/2024
1.5.0 165 7/6/2024
1.5.0-beta-0010 138 7/6/2024
1.5.0-beta-0006 131 7/4/2024
1.4.5 154 7/4/2024
1.4.2 163 6/30/2024
1.4.1 164 6/30/2024
1.4.0 163 6/30/2024
1.4.0-beta-0010 150 6/30/2024
1.3.1 165 6/29/2024
1.3.0 151 6/29/2024
1.3.0-beta-0014 136 6/29/2024
1.3.0-beta-0007 127 6/26/2024
1.2.0 156 6/20/2024
1.2.0-beta-0001 116 6/20/2024
1.1.0 152 6/17/2024
1.1.0-beta-0019 125 6/20/2024
1.1.0-beta-0016 128 6/19/2024
1.1.0-beta-0014 137 6/17/2024
1.1.0-beta-0013 137 6/17/2024
1.0.0 182 6/15/2024
1.0.0-alpha-0054 131 6/15/2024
1.0.0-alpha-0053 130 6/12/2024
1.0.0-alpha-0051 111 6/12/2024
1.0.0-alpha-0048 126 6/10/2024
1.0.0-alpha-0047 131 6/10/2024
1.0.0-alpha-0043 117 6/9/2024
1.0.0-alpha-0042 152 6/7/2024
1.0.0-alpha-0040 127 6/6/2024
1.0.0-alpha-0038 124 6/6/2024
1.0.0-alpha-0036 114 6/5/2024
1.0.0-alpha-0034 141 6/4/2024
1.0.0-alpha-0031 122 6/4/2024
1.0.0-alpha-0025 123 6/3/2024
1.0.0-alpha-0023 132 6/2/2024
1.0.0-alpha-0022 133 6/1/2024
1.0.0-alpha-0019 129 6/1/2024
1.0.0-alpha-0018 117 6/1/2024
1.0.0-alpha-0014 128 6/1/2024
1.0.0-alpha-0013 113 6/1/2024
1.0.0-alpha-0012 117 5/31/2024
1.0.0-alpha-0011 111 5/31/2024
1.0.0-alpha-0010 118 5/31/2024