Shiny.Mediator 1.0.0-alpha-0019

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

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 266 9/19/2025
4.10.0-beta-0019 339 9/18/2025
4.10.0-beta-0018 333 9/18/2025
4.10.0-beta-0017 329 9/18/2025
4.10.0-beta-0016 334 9/18/2025
4.10.0-beta-0015 326 9/18/2025
4.10.0-beta-0014 334 9/18/2025
4.10.0-beta-0013 335 9/18/2025
4.10.0-beta-0012 338 9/18/2025
4.10.0-beta-0011 325 9/16/2025
4.10.0-beta-0010 339 9/16/2025
4.10.0-beta-0009 200 9/10/2025
4.10.0-beta-0008 183 9/10/2025
4.10.0-beta-0007 186 9/9/2025
4.10.0-beta-0006 260 8/28/2025
4.10.0-beta-0005 152 8/22/2025
4.10.0-beta-0004 177 8/22/2025
4.10.0-beta-0003 185 8/18/2025
4.10.0-beta-0002 185 8/18/2025
4.10.0-beta-0001 146 7/29/2025
4.9.1 657 7/29/2025
4.9.0 241 7/26/2025
4.9.0-beta-0005 584 7/22/2025
4.9.0-beta-0004 583 7/22/2025
4.9.0-beta-0003 580 7/22/2025
4.9.0-beta-0002 554 7/21/2025
4.9.0-beta-0001 480 7/21/2025
4.8.0 315 7/18/2025
4.8.0-beta-0004 149 7/18/2025
4.8.0-beta-0003 224 7/14/2025
4.8.0-beta-0002 208 7/14/2025
4.8.0-beta-0001 203 7/14/2025
4.7.0 471 6/25/2025
4.7.0-beta-0026 199 7/13/2025
4.7.0-beta-0025 209 7/10/2025
4.7.0-beta-0024 141 6/25/2025
4.7.0-beta-0023 210 6/25/2025
4.7.0-beta-0022 208 6/24/2025
4.7.0-beta-0021 218 6/23/2025
4.7.0-beta-0020 213 6/19/2025
4.7.0-beta-0004 216 6/19/2025
4.6.6 231 6/19/2025
4.6.5 217 6/19/2025
4.6.4 215 6/19/2025
4.6.3 530 6/18/2025
4.6.2 227 6/18/2025
4.6.1 252 6/16/2025
4.6.1-beta-0005 224 6/18/2025
4.6.1-beta-0003 211 6/18/2025
4.6.1-beta-0001 214 6/16/2025
4.6.0 229 6/16/2025
4.5.0 425 6/10/2025
4.5.0-beta-0007 362 6/10/2025
4.5.0-beta-0006 330 6/9/2025
4.5.0-beta-0004 176 6/6/2025
4.5.0-beta-0002 208 6/6/2025
4.4.0 470 6/3/2025
4.4.0-beta-0025 215 6/3/2025
4.4.0-beta-0023 211 5/29/2025
4.4.0-beta-0021 218 5/29/2025
4.4.0-beta-0018 223 5/26/2025
4.4.0-beta-0017 226 5/26/2025
4.4.0-beta-0015 218 5/26/2025
4.4.0-beta-0014 214 5/26/2025
4.4.0-beta-0004 182 5/25/2025
4.2.2 511 5/24/2025
4.2.1 395 5/8/2025
4.2.0 359 4/25/2025
4.2.0-beta-0010 234 5/8/2025
4.2.0-beta-0009 229 5/8/2025
4.2.0-beta-0008 199 4/25/2025
4.2.0-beta-0001 282 4/16/2025
4.1.0 543 3/28/2025
4.1.0-beta-0001 220 3/28/2025
4.0.4 523 3/24/2025
4.0.4-beta-0001 498 3/24/2025
4.0.3 347 3/23/2025
4.0.3-beta-0007 338 3/23/2025
4.0.2 323 3/15/2025
4.0.1 466 3/5/2025
4.0.1-beta-0010 241 3/19/2025
4.0.1-beta-0009 156 3/15/2025
4.0.1-beta-0001 308 3/5/2025
4.0.0 310 3/4/2025
4.0.0-beta-0021 298 3/4/2025
4.0.0-beta-0017 295 3/4/2025
4.0.0-beta-0016 297 3/4/2025
4.0.0-beta-0010 176 3/2/2025
4.0.0-beta-0009 176 3/2/2025
4.0.0-beta-0002 198 3/1/2025
3.3.1 370 2/20/2025
3.3.0 190 2/20/2025
3.3.0-beta-0028 175 2/20/2025
3.3.0-beta-0025 203 2/19/2025
3.3.0-beta-0024 231 2/19/2025
3.3.0-beta-0004 173 2/8/2025
3.2.0 462 1/29/2025
3.2.0-beta-0027 168 1/29/2025
3.2.0-beta-0023 179 1/29/2025
3.2.0-beta-0020 174 1/29/2025
3.1.3 171 1/29/2025
3.1.2 187 1/28/2025
3.1.1 190 1/25/2025
3.1.0 170 1/25/2025
3.1.0-beta-0013 171 1/25/2025
3.1.0-beta-0006 165 1/25/2025
3.1.0-beta-0004 157 1/25/2025
3.0.0 172 1/24/2025
3.0.0-beta-0055 177 1/24/2025
3.0.0-beta-0046 166 1/23/2025
3.0.0-beta-0045 161 1/23/2025
3.0.0-beta-0043 188 1/23/2025
3.0.0-beta-0038 188 1/21/2025
3.0.0-beta-0037 162 1/21/2025
3.0.0-beta-0029 175 1/21/2025
3.0.0-beta-0028 176 1/21/2025
3.0.0-beta-0018 162 1/19/2025
3.0.0-beta-0016 148 1/14/2025
3.0.0-beta-0012 163 1/12/2025
3.0.0-beta-0008 192 1/2/2025
3.0.0-beta-0007 163 12/28/2024
3.0.0-beta-0004 155 12/22/2024
2.2.0-beta-0001 389 10/28/2024
2.1.1 808 10/28/2024
2.1.0 320 10/19/2024
2.1.0-beta-0016 169 10/19/2024
2.1.0-beta-0015 176 10/19/2024
2.1.0-beta-0014 194 10/19/2024
2.1.0-beta-0013 192 10/19/2024
2.1.0-beta-0011 197 10/18/2024
2.1.0-beta-0010 181 10/18/2024
2.1.0-beta-0004 185 10/8/2024
2.1.0-beta-0002 171 10/6/2024
2.0.2 444 10/6/2024
2.0.1 193 10/6/2024
2.0.0 286 10/4/2024
2.0.0-beta-0060 176 10/6/2024
2.0.0-beta-0059 163 10/6/2024
2.0.0-beta-0056 166 10/4/2024
2.0.0-beta-0054 175 10/3/2024
2.0.0-beta-0053 176 10/2/2024
2.0.0-beta-0052 181 10/2/2024
2.0.0-beta-0050 179 10/2/2024
2.0.0-beta-0049 182 10/2/2024
2.0.0-beta-0046 192 10/1/2024
2.0.0-beta-0044 185 9/30/2024
2.0.0-beta-0026 188 9/24/2024
2.0.0-beta-0023 176 9/23/2024
2.0.0-beta-0022 156 9/23/2024
2.0.0-beta-0020 157 9/22/2024
2.0.0-beta-0004 161 9/20/2024
2.0.0-beta-0003 185 9/20/2024
1.9.0-beta-0003 188 9/16/2024
1.9.0-beta-0001 184 9/15/2024
1.9.0-beta 192 9/15/2024
1.8.1 372 9/14/2024
1.8.1-beta-0006 186 9/14/2024
1.8.1-beta-0005 167 9/14/2024
1.8.1-beta-0004 185 9/14/2024
1.8.1-beta-0003 171 9/14/2024
1.8.1-beta-0002 178 9/14/2024
1.8.1-beta-0001 173 9/14/2024
1.8.0 244 9/12/2024
1.8.0-beta-0064 189 9/12/2024
1.8.0-beta-0063 197 9/12/2024
1.8.0-beta-0059 199 9/8/2024
1.8.0-beta-0058 179 9/8/2024
1.8.0-beta-0057 203 9/8/2024
1.8.0-beta-0054 200 9/7/2024
1.8.0-beta-0053 211 9/6/2024
1.8.0-beta-0052 196 9/6/2024
1.8.0-beta-0051 194 9/6/2024
1.8.0-beta-0044 218 9/5/2024
1.8.0-beta-0042 201 9/4/2024
1.8.0-beta-0041 201 9/4/2024
1.8.0-beta-0027 211 8/25/2024
1.8.0-beta-0022 209 8/23/2024
1.8.0-beta-0017 200 8/7/2024
1.8.0-beta-0012 152 7/28/2024
1.8.0-beta-0010 132 7/28/2024
1.7.5 262 8/23/2024
1.7.4 369 8/9/2024
1.7.3 211 8/7/2024
1.7.2 195 7/28/2024
1.7.1 154 7/28/2024
1.7.0 223 7/20/2024
1.7.0-beta-0005 149 7/20/2024
1.7.0-beta-0001 167 7/8/2024
1.6.0 217 7/8/2024
1.6.0-beta-0004 164 7/7/2024
1.5.0 198 7/6/2024
1.5.0-beta-0010 173 7/6/2024
1.5.0-beta-0006 173 7/4/2024
1.4.5 186 7/4/2024
1.4.2 204 6/30/2024
1.4.1 201 6/30/2024
1.4.0 200 6/30/2024
1.4.0-beta-0010 197 6/30/2024
1.3.1 207 6/29/2024
1.3.0 188 6/29/2024
1.3.0-beta-0014 176 6/29/2024
1.3.0-beta-0007 158 6/26/2024
1.2.0 191 6/20/2024
1.2.0-beta-0001 147 6/20/2024
1.1.0 191 6/17/2024
1.1.0-beta-0019 163 6/20/2024
1.1.0-beta-0016 169 6/19/2024
1.1.0-beta-0014 157 6/17/2024
1.1.0-beta-0013 164 6/17/2024
1.0.0 222 6/15/2024
1.0.0-alpha-0054 148 6/15/2024
1.0.0-alpha-0053 166 6/12/2024
1.0.0-alpha-0051 148 6/12/2024
1.0.0-alpha-0048 158 6/10/2024
1.0.0-alpha-0047 152 6/10/2024
1.0.0-alpha-0043 134 6/9/2024
1.0.0-alpha-0042 196 6/7/2024
1.0.0-alpha-0040 165 6/6/2024
1.0.0-alpha-0038 163 6/6/2024
1.0.0-alpha-0036 148 6/5/2024
1.0.0-alpha-0034 158 6/4/2024
1.0.0-alpha-0031 145 6/4/2024
1.0.0-alpha-0025 144 6/3/2024
1.0.0-alpha-0023 166 6/2/2024
1.0.0-alpha-0022 157 6/1/2024
1.0.0-alpha-0019 161 6/1/2024
1.0.0-alpha-0018 154 6/1/2024
1.0.0-alpha-0014 148 6/1/2024
1.0.0-alpha-0013 141 6/1/2024
1.0.0-alpha-0012 146 5/31/2024
1.0.0-alpha-0011 136 5/31/2024
1.0.0-alpha-0010 134 5/31/2024