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.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 308 9/19/2025
4.10.0-beta-0019 375 9/18/2025
4.10.0-beta-0018 369 9/18/2025
4.10.0-beta-0017 372 9/18/2025
4.10.0-beta-0016 370 9/18/2025
4.10.0-beta-0015 366 9/18/2025
4.10.0-beta-0014 369 9/18/2025
4.10.0-beta-0013 373 9/18/2025
4.10.0-beta-0012 366 9/18/2025
4.10.0-beta-0011 350 9/16/2025
4.10.0-beta-0010 368 9/16/2025
4.10.0-beta-0009 231 9/10/2025
4.10.0-beta-0008 211 9/10/2025
4.10.0-beta-0007 214 9/9/2025
4.10.0-beta-0006 288 8/28/2025
4.10.0-beta-0005 180 8/22/2025
4.10.0-beta-0004 204 8/22/2025
4.10.0-beta-0003 216 8/18/2025
4.10.0-beta-0002 210 8/18/2025
4.10.0-beta-0001 171 7/29/2025
4.9.1 693 7/29/2025
4.9.0 287 7/26/2025
4.9.0-beta-0005 617 7/22/2025
4.9.0-beta-0004 619 7/22/2025
4.9.0-beta-0003 616 7/22/2025
4.9.0-beta-0002 576 7/21/2025
4.9.0-beta-0001 504 7/21/2025
4.8.0 340 7/18/2025
4.8.0-beta-0004 170 7/18/2025
4.8.0-beta-0003 246 7/14/2025
4.8.0-beta-0002 230 7/14/2025
4.8.0-beta-0001 225 7/14/2025
4.7.0 494 6/25/2025
4.7.0-beta-0026 221 7/13/2025
4.7.0-beta-0025 221 7/10/2025
4.7.0-beta-0024 154 6/25/2025
4.7.0-beta-0023 232 6/25/2025
4.7.0-beta-0022 230 6/24/2025
4.7.0-beta-0021 241 6/23/2025
4.7.0-beta-0020 234 6/19/2025
4.7.0-beta-0004 243 6/19/2025
4.6.6 265 6/19/2025
4.6.5 239 6/19/2025
4.6.4 237 6/19/2025
4.6.3 553 6/18/2025
4.6.2 250 6/18/2025
4.6.1 276 6/16/2025
4.6.1-beta-0005 234 6/18/2025
4.6.1-beta-0003 223 6/18/2025
4.6.1-beta-0001 237 6/16/2025
4.6.0 252 6/16/2025
4.5.0 448 6/10/2025
4.5.0-beta-0007 378 6/10/2025
4.5.0-beta-0006 346 6/9/2025
4.5.0-beta-0004 197 6/6/2025
4.5.0-beta-0002 232 6/6/2025
4.4.0 495 6/3/2025
4.4.0-beta-0025 233 6/3/2025
4.4.0-beta-0023 233 5/29/2025
4.4.0-beta-0021 241 5/29/2025
4.4.0-beta-0018 245 5/26/2025
4.4.0-beta-0017 249 5/26/2025
4.4.0-beta-0015 231 5/26/2025
4.4.0-beta-0014 226 5/26/2025
4.4.0-beta-0004 210 5/25/2025
4.2.2 539 5/24/2025
4.2.1 424 5/8/2025
4.2.0 384 4/25/2025
4.2.0-beta-0010 258 5/8/2025
4.2.0-beta-0009 253 5/8/2025
4.2.0-beta-0008 225 4/25/2025
4.2.0-beta-0001 309 4/16/2025
4.1.0 570 3/28/2025
4.1.0-beta-0001 247 3/28/2025
4.0.4 550 3/24/2025
4.0.4-beta-0001 524 3/24/2025
4.0.3 373 3/23/2025
4.0.3-beta-0007 364 3/23/2025
4.0.2 350 3/15/2025
4.0.1 493 3/5/2025
4.0.1-beta-0010 270 3/19/2025
4.0.1-beta-0009 171 3/15/2025
4.0.1-beta-0001 328 3/5/2025
4.0.0 335 3/4/2025
4.0.0-beta-0021 323 3/4/2025
4.0.0-beta-0017 320 3/4/2025
4.0.0-beta-0016 325 3/4/2025
4.0.0-beta-0010 202 3/2/2025
4.0.0-beta-0009 203 3/2/2025
4.0.0-beta-0002 226 3/1/2025
3.3.1 388 2/20/2025
3.3.0 215 2/20/2025
3.3.0-beta-0028 193 2/20/2025
3.3.0-beta-0025 228 2/19/2025
3.3.0-beta-0024 258 2/19/2025
3.3.0-beta-0004 198 2/8/2025
3.2.0 482 1/29/2025
3.2.0-beta-0027 188 1/29/2025
3.2.0-beta-0023 188 1/29/2025
3.2.0-beta-0020 195 1/29/2025
3.1.3 190 1/29/2025
3.1.2 207 1/28/2025
3.1.1 220 1/25/2025
3.1.0 189 1/25/2025
3.1.0-beta-0013 190 1/25/2025
3.1.0-beta-0006 175 1/25/2025
3.1.0-beta-0004 174 1/25/2025
3.0.0 189 1/24/2025
3.0.0-beta-0055 197 1/24/2025
3.0.0-beta-0046 186 1/23/2025
3.0.0-beta-0045 181 1/23/2025
3.0.0-beta-0043 208 1/23/2025
3.0.0-beta-0038 208 1/21/2025
3.0.0-beta-0037 183 1/21/2025
3.0.0-beta-0029 198 1/21/2025
3.0.0-beta-0028 197 1/21/2025
3.0.0-beta-0018 180 1/19/2025
3.0.0-beta-0016 178 1/14/2025
3.0.0-beta-0012 184 1/12/2025
3.0.0-beta-0008 209 1/2/2025
3.0.0-beta-0007 182 12/28/2024
3.0.0-beta-0004 167 12/22/2024
2.2.0-beta-0001 407 10/28/2024
2.1.1 840 10/28/2024
2.1.0 342 10/19/2024
2.1.0-beta-0016 187 10/19/2024
2.1.0-beta-0015 201 10/19/2024
2.1.0-beta-0014 216 10/19/2024
2.1.0-beta-0013 213 10/19/2024
2.1.0-beta-0011 219 10/18/2024
2.1.0-beta-0010 199 10/18/2024
2.1.0-beta-0004 206 10/8/2024
2.1.0-beta-0002 193 10/6/2024
2.0.2 466 10/6/2024
2.0.1 215 10/6/2024
2.0.0 309 10/4/2024
2.0.0-beta-0060 194 10/6/2024
2.0.0-beta-0059 185 10/6/2024
2.0.0-beta-0056 195 10/4/2024
2.0.0-beta-0054 199 10/3/2024
2.0.0-beta-0053 200 10/2/2024
2.0.0-beta-0052 204 10/2/2024
2.0.0-beta-0050 191 10/2/2024
2.0.0-beta-0049 204 10/2/2024
2.0.0-beta-0046 211 10/1/2024
2.0.0-beta-0044 209 9/30/2024
2.0.0-beta-0026 202 9/24/2024
2.0.0-beta-0023 204 9/23/2024
2.0.0-beta-0022 174 9/23/2024
2.0.0-beta-0020 179 9/22/2024
2.0.0-beta-0004 170 9/20/2024
2.0.0-beta-0003 198 9/20/2024
1.9.0-beta-0003 204 9/16/2024
1.9.0-beta-0001 203 9/15/2024
1.9.0-beta 206 9/15/2024
1.8.1 392 9/14/2024
1.8.1-beta-0006 205 9/14/2024
1.8.1-beta-0005 175 9/14/2024
1.8.1-beta-0004 206 9/14/2024
1.8.1-beta-0003 189 9/14/2024
1.8.1-beta-0002 197 9/14/2024
1.8.1-beta-0001 191 9/14/2024
1.8.0 260 9/12/2024
1.8.0-beta-0064 208 9/12/2024
1.8.0-beta-0063 212 9/12/2024
1.8.0-beta-0059 205 9/8/2024
1.8.0-beta-0058 197 9/8/2024
1.8.0-beta-0057 223 9/8/2024
1.8.0-beta-0054 218 9/7/2024
1.8.0-beta-0053 229 9/6/2024
1.8.0-beta-0052 210 9/6/2024
1.8.0-beta-0051 211 9/6/2024
1.8.0-beta-0044 232 9/5/2024
1.8.0-beta-0042 226 9/4/2024
1.8.0-beta-0041 207 9/4/2024
1.8.0-beta-0027 231 8/25/2024
1.8.0-beta-0022 220 8/23/2024
1.8.0-beta-0017 218 8/7/2024
1.8.0-beta-0012 170 7/28/2024
1.8.0-beta-0010 137 7/28/2024
1.7.5 271 8/23/2024
1.7.4 378 8/9/2024
1.7.3 229 8/7/2024
1.7.2 202 7/28/2024
1.7.1 162 7/28/2024
1.7.0 243 7/20/2024
1.7.0-beta-0005 167 7/20/2024
1.7.0-beta-0001 185 7/8/2024
1.6.0 233 7/8/2024
1.6.0-beta-0004 182 7/7/2024
1.5.0 204 7/6/2024
1.5.0-beta-0010 192 7/6/2024
1.5.0-beta-0006 189 7/4/2024
1.4.5 189 7/4/2024
1.4.2 220 6/30/2024
1.4.1 219 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 199 6/29/2024
1.3.0-beta-0014 179 6/29/2024
1.3.0-beta-0007 168 6/26/2024
1.2.0 201 6/20/2024
1.2.0-beta-0001 160 6/20/2024
1.1.0 201 6/17/2024
1.1.0-beta-0019 175 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 233 6/15/2024
1.0.0-alpha-0054 158 6/15/2024
1.0.0-alpha-0053 178 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 165 6/6/2024
1.0.0-alpha-0036 163 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 146 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 135 5/31/2024