Shiny.Mediator 1.0.0-alpha-0011

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

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 257 9/19/2025
4.10.0-beta-0019 329 9/18/2025
4.10.0-beta-0018 326 9/18/2025
4.10.0-beta-0017 323 9/18/2025
4.10.0-beta-0016 327 9/18/2025
4.10.0-beta-0015 319 9/18/2025
4.10.0-beta-0014 327 9/18/2025
4.10.0-beta-0013 327 9/18/2025
4.10.0-beta-0012 334 9/18/2025
4.10.0-beta-0011 321 9/16/2025
4.10.0-beta-0010 335 9/16/2025
4.10.0-beta-0009 187 9/10/2025
4.10.0-beta-0008 170 9/10/2025
4.10.0-beta-0007 172 9/9/2025
4.10.0-beta-0006 246 8/28/2025
4.10.0-beta-0005 138 8/22/2025
4.10.0-beta-0004 163 8/22/2025
4.10.0-beta-0003 172 8/18/2025
4.10.0-beta-0002 171 8/18/2025
4.10.0-beta-0001 143 7/29/2025
4.9.1 652 7/29/2025
4.9.0 237 7/26/2025
4.9.0-beta-0005 581 7/22/2025
4.9.0-beta-0004 580 7/22/2025
4.9.0-beta-0003 577 7/22/2025
4.9.0-beta-0002 551 7/21/2025
4.9.0-beta-0001 477 7/21/2025
4.8.0 312 7/18/2025
4.8.0-beta-0004 147 7/18/2025
4.8.0-beta-0003 224 7/14/2025
4.8.0-beta-0002 205 7/14/2025
4.8.0-beta-0001 200 7/14/2025
4.7.0 468 6/25/2025
4.7.0-beta-0026 196 7/13/2025
4.7.0-beta-0025 206 7/10/2025
4.7.0-beta-0024 141 6/25/2025
4.7.0-beta-0023 208 6/25/2025
4.7.0-beta-0022 205 6/24/2025
4.7.0-beta-0021 215 6/23/2025
4.7.0-beta-0020 210 6/19/2025
4.7.0-beta-0004 213 6/19/2025
4.6.6 227 6/19/2025
4.6.5 214 6/19/2025
4.6.4 212 6/19/2025
4.6.3 523 6/18/2025
4.6.2 224 6/18/2025
4.6.1 249 6/16/2025
4.6.1-beta-0005 221 6/18/2025
4.6.1-beta-0003 208 6/18/2025
4.6.1-beta-0001 211 6/16/2025
4.6.0 226 6/16/2025
4.5.0 422 6/10/2025
4.5.0-beta-0007 359 6/10/2025
4.5.0-beta-0006 327 6/9/2025
4.5.0-beta-0004 172 6/6/2025
4.5.0-beta-0002 205 6/6/2025
4.4.0 467 6/3/2025
4.4.0-beta-0025 212 6/3/2025
4.4.0-beta-0023 208 5/29/2025
4.4.0-beta-0021 215 5/29/2025
4.4.0-beta-0018 220 5/26/2025
4.4.0-beta-0017 223 5/26/2025
4.4.0-beta-0015 215 5/26/2025
4.4.0-beta-0014 211 5/26/2025
4.4.0-beta-0004 179 5/25/2025
4.2.2 508 5/24/2025
4.2.1 395 5/8/2025
4.2.0 355 4/25/2025
4.2.0-beta-0010 231 5/8/2025
4.2.0-beta-0009 226 5/8/2025
4.2.0-beta-0008 195 4/25/2025
4.2.0-beta-0001 279 4/16/2025
4.1.0 540 3/28/2025
4.1.0-beta-0001 217 3/28/2025
4.0.4 519 3/24/2025
4.0.4-beta-0001 495 3/24/2025
4.0.3 344 3/23/2025
4.0.3-beta-0007 335 3/23/2025
4.0.2 319 3/15/2025
4.0.1 463 3/5/2025
4.0.1-beta-0010 237 3/19/2025
4.0.1-beta-0009 153 3/15/2025
4.0.1-beta-0001 305 3/5/2025
4.0.0 307 3/4/2025
4.0.0-beta-0021 295 3/4/2025
4.0.0-beta-0017 292 3/4/2025
4.0.0-beta-0016 293 3/4/2025
4.0.0-beta-0010 173 3/2/2025
4.0.0-beta-0009 173 3/2/2025
4.0.0-beta-0002 194 3/1/2025
3.3.1 366 2/20/2025
3.3.0 187 2/20/2025
3.3.0-beta-0028 172 2/20/2025
3.3.0-beta-0025 200 2/19/2025
3.3.0-beta-0024 225 2/19/2025
3.3.0-beta-0004 170 2/8/2025
3.2.0 459 1/29/2025
3.2.0-beta-0027 165 1/29/2025
3.2.0-beta-0023 176 1/29/2025
3.2.0-beta-0020 167 1/29/2025
3.1.3 168 1/29/2025
3.1.2 184 1/28/2025
3.1.1 188 1/25/2025
3.1.0 167 1/25/2025
3.1.0-beta-0013 168 1/25/2025
3.1.0-beta-0006 162 1/25/2025
3.1.0-beta-0004 155 1/25/2025
3.0.0 169 1/24/2025
3.0.0-beta-0055 173 1/24/2025
3.0.0-beta-0046 163 1/23/2025
3.0.0-beta-0045 158 1/23/2025
3.0.0-beta-0043 185 1/23/2025
3.0.0-beta-0038 185 1/21/2025
3.0.0-beta-0037 159 1/21/2025
3.0.0-beta-0029 171 1/21/2025
3.0.0-beta-0028 173 1/21/2025
3.0.0-beta-0018 158 1/19/2025
3.0.0-beta-0016 145 1/14/2025
3.0.0-beta-0012 160 1/12/2025
3.0.0-beta-0008 186 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 285 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 165 10/4/2024
2.0.0-beta-0054 175 10/3/2024
2.0.0-beta-0053 175 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 181 10/2/2024
2.0.0-beta-0046 191 10/1/2024
2.0.0-beta-0044 184 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 191 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 184 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 195 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 199 8/7/2024
1.8.0-beta-0012 151 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 194 7/28/2024
1.7.1 154 7/28/2024
1.7.0 222 7/20/2024
1.7.0-beta-0005 149 7/20/2024
1.7.0-beta-0001 166 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 187 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 221 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 133 5/31/2024