Shiny.Mediator 1.0.0-alpha-0012

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

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Blazor

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 215 9/19/2025
4.10.0-beta-0019 289 9/18/2025
4.10.0-beta-0018 282 9/18/2025
4.10.0-beta-0017 282 9/18/2025
4.10.0-beta-0016 285 9/18/2025
4.10.0-beta-0015 281 9/18/2025
4.10.0-beta-0014 284 9/18/2025
4.10.0-beta-0013 285 9/18/2025
4.10.0-beta-0012 306 9/18/2025
4.10.0-beta-0011 317 9/16/2025
4.10.0-beta-0010 327 9/16/2025
4.10.0-beta-0009 178 9/10/2025
4.10.0-beta-0008 162 9/10/2025
4.10.0-beta-0007 164 9/9/2025
4.10.0-beta-0006 241 8/28/2025
4.10.0-beta-0005 130 8/22/2025
4.10.0-beta-0004 159 8/22/2025
4.10.0-beta-0003 164 8/18/2025
4.10.0-beta-0002 163 8/18/2025
4.10.0-beta-0001 135 7/29/2025
4.9.1 625 7/29/2025
4.9.0 224 7/26/2025
4.9.0-beta-0005 577 7/22/2025
4.9.0-beta-0004 572 7/22/2025
4.9.0-beta-0003 569 7/22/2025
4.9.0-beta-0002 544 7/21/2025
4.9.0-beta-0001 469 7/21/2025
4.8.0 303 7/18/2025
4.8.0-beta-0004 141 7/18/2025
4.8.0-beta-0003 220 7/14/2025
4.8.0-beta-0002 198 7/14/2025
4.8.0-beta-0001 192 7/14/2025
4.7.0 459 6/25/2025
4.7.0-beta-0026 188 7/13/2025
4.7.0-beta-0025 198 7/10/2025
4.7.0-beta-0024 141 6/25/2025
4.7.0-beta-0023 200 6/25/2025
4.7.0-beta-0022 198 6/24/2025
4.7.0-beta-0021 207 6/23/2025
4.7.0-beta-0020 202 6/19/2025
4.7.0-beta-0004 209 6/19/2025
4.6.6 216 6/19/2025
4.6.5 206 6/19/2025
4.6.4 204 6/19/2025
4.6.3 510 6/18/2025
4.6.2 216 6/18/2025
4.6.1 241 6/16/2025
4.6.1-beta-0005 213 6/18/2025
4.6.1-beta-0003 200 6/18/2025
4.6.1-beta-0001 207 6/16/2025
4.6.0 217 6/16/2025
4.5.0 413 6/10/2025
4.5.0-beta-0007 351 6/10/2025
4.5.0-beta-0006 323 6/9/2025
4.5.0-beta-0004 164 6/6/2025
4.5.0-beta-0002 197 6/6/2025
4.4.0 457 6/3/2025
4.4.0-beta-0025 204 6/3/2025
4.4.0-beta-0023 201 5/29/2025
4.4.0-beta-0021 206 5/29/2025
4.4.0-beta-0018 212 5/26/2025
4.4.0-beta-0017 215 5/26/2025
4.4.0-beta-0015 205 5/26/2025
4.4.0-beta-0014 203 5/26/2025
4.4.0-beta-0004 171 5/25/2025
4.2.2 500 5/24/2025
4.2.1 387 5/8/2025
4.2.0 347 4/25/2025
4.2.0-beta-0010 226 5/8/2025
4.2.0-beta-0009 218 5/8/2025
4.2.0-beta-0008 187 4/25/2025
4.2.0-beta-0001 275 4/16/2025
4.1.0 531 3/28/2025
4.1.0-beta-0001 209 3/28/2025
4.0.4 512 3/24/2025
4.0.4-beta-0001 487 3/24/2025
4.0.3 336 3/23/2025
4.0.3-beta-0007 327 3/23/2025
4.0.2 314 3/15/2025
4.0.1 454 3/5/2025
4.0.1-beta-0010 229 3/19/2025
4.0.1-beta-0009 149 3/15/2025
4.0.1-beta-0001 301 3/5/2025
4.0.0 298 3/4/2025
4.0.0-beta-0021 287 3/4/2025
4.0.0-beta-0017 285 3/4/2025
4.0.0-beta-0016 285 3/4/2025
4.0.0-beta-0010 167 3/2/2025
4.0.0-beta-0009 165 3/2/2025
4.0.0-beta-0002 186 3/1/2025
3.3.1 358 2/20/2025
3.3.0 179 2/20/2025
3.3.0-beta-0028 163 2/20/2025
3.3.0-beta-0025 193 2/19/2025
3.3.0-beta-0024 217 2/19/2025
3.3.0-beta-0004 162 2/8/2025
3.2.0 451 1/29/2025
3.2.0-beta-0027 156 1/29/2025
3.2.0-beta-0023 168 1/29/2025
3.2.0-beta-0020 161 1/29/2025
3.1.3 160 1/29/2025
3.1.2 176 1/28/2025
3.1.1 184 1/25/2025
3.1.0 159 1/25/2025
3.1.0-beta-0013 161 1/25/2025
3.1.0-beta-0006 153 1/25/2025
3.1.0-beta-0004 147 1/25/2025
3.0.0 161 1/24/2025
3.0.0-beta-0055 161 1/24/2025
3.0.0-beta-0046 155 1/23/2025
3.0.0-beta-0045 150 1/23/2025
3.0.0-beta-0043 177 1/23/2025
3.0.0-beta-0038 177 1/21/2025
3.0.0-beta-0037 155 1/21/2025
3.0.0-beta-0029 163 1/21/2025
3.0.0-beta-0028 165 1/21/2025
3.0.0-beta-0018 153 1/19/2025
3.0.0-beta-0016 135 1/14/2025
3.0.0-beta-0012 152 1/12/2025
3.0.0-beta-0008 183 1/2/2025
3.0.0-beta-0007 159 12/28/2024
3.0.0-beta-0004 147 12/22/2024
2.2.0-beta-0001 384 10/28/2024
2.1.1 804 10/28/2024
2.1.0 316 10/19/2024
2.1.0-beta-0016 165 10/19/2024
2.1.0-beta-0015 172 10/19/2024
2.1.0-beta-0014 189 10/19/2024
2.1.0-beta-0013 187 10/19/2024
2.1.0-beta-0011 193 10/18/2024
2.1.0-beta-0010 181 10/18/2024
2.1.0-beta-0004 180 10/8/2024
2.1.0-beta-0002 167 10/6/2024
2.0.2 444 10/6/2024
2.0.1 189 10/6/2024
2.0.0 281 10/4/2024
2.0.0-beta-0060 171 10/6/2024
2.0.0-beta-0059 159 10/6/2024
2.0.0-beta-0056 165 10/4/2024
2.0.0-beta-0054 171 10/3/2024
2.0.0-beta-0053 171 10/2/2024
2.0.0-beta-0052 177 10/2/2024
2.0.0-beta-0050 174 10/2/2024
2.0.0-beta-0049 177 10/2/2024
2.0.0-beta-0046 187 10/1/2024
2.0.0-beta-0044 180 9/30/2024
2.0.0-beta-0026 184 9/24/2024
2.0.0-beta-0023 172 9/23/2024
2.0.0-beta-0022 152 9/23/2024
2.0.0-beta-0020 153 9/22/2024
2.0.0-beta-0004 157 9/20/2024
2.0.0-beta-0003 181 9/20/2024
1.9.0-beta-0003 183 9/16/2024
1.9.0-beta-0001 179 9/15/2024
1.9.0-beta 187 9/15/2024
1.8.1 368 9/14/2024
1.8.1-beta-0006 181 9/14/2024
1.8.1-beta-0005 167 9/14/2024
1.8.1-beta-0004 180 9/14/2024
1.8.1-beta-0003 167 9/14/2024
1.8.1-beta-0002 174 9/14/2024
1.8.1-beta-0001 169 9/14/2024
1.8.0 244 9/12/2024
1.8.0-beta-0064 184 9/12/2024
1.8.0-beta-0063 193 9/12/2024
1.8.0-beta-0059 195 9/8/2024
1.8.0-beta-0058 175 9/8/2024
1.8.0-beta-0057 199 9/8/2024
1.8.0-beta-0054 196 9/7/2024
1.8.0-beta-0053 206 9/6/2024
1.8.0-beta-0052 190 9/6/2024
1.8.0-beta-0051 190 9/6/2024
1.8.0-beta-0044 214 9/5/2024
1.8.0-beta-0042 197 9/4/2024
1.8.0-beta-0041 196 9/4/2024
1.8.0-beta-0027 209 8/25/2024
1.8.0-beta-0022 204 8/23/2024
1.8.0-beta-0017 195 8/7/2024
1.8.0-beta-0012 148 7/28/2024
1.8.0-beta-0010 128 7/28/2024
1.7.5 257 8/23/2024
1.7.4 365 8/9/2024
1.7.3 207 8/7/2024
1.7.2 190 7/28/2024
1.7.1 150 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 172 7/4/2024
1.4.5 186 7/4/2024
1.4.2 203 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 175 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 165 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 153 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 145 5/31/2024
1.0.0-alpha-0011 136 5/31/2024
1.0.0-alpha-0010 133 5/31/2024