Shiny.Mediator 1.0.0-alpha-0018

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-0018
                    
NuGet\Install-Package Shiny.Mediator -Version 1.0.0-alpha-0018
                    
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-0018" />
                    
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-0018" />
                    
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-0018
                    
#r "nuget: Shiny.Mediator, 1.0.0-alpha-0018"
                    
#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-0018
                    
#: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-0018&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator&version=1.0.0-alpha-0018&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
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
5.1.0 172 10/27/2025
5.1.0-beta-0002 171 10/27/2025
5.1.0-beta-0001 173 10/25/2025
5.0.0 183 10/25/2025
5.0.0-beta-0012 295 10/23/2025
5.0.0-beta-0011 295 10/22/2025
5.0.0-beta-0010 303 10/22/2025
5.0.0-beta-0009 304 10/21/2025
5.0.0-beta-0008 311 10/19/2025
5.0.0-beta-0007 238 10/18/2025
5.0.0-beta-0006 244 10/17/2025
5.0.0-beta-0005 288 10/17/2025
5.0.0-beta-0004 297 10/10/2025
5.0.0-beta-0003 304 10/9/2025
5.0.0-beta-0002 294 10/8/2025
5.0.0-beta-0001 305 10/7/2025
4.10.0-beta-0020 382 9/19/2025
4.10.0-beta-0019 447 9/18/2025
4.10.0-beta-0018 432 9/18/2025
4.10.0-beta-0017 436 9/18/2025
4.10.0-beta-0016 440 9/18/2025
4.10.0-beta-0015 430 9/18/2025
4.10.0-beta-0014 431 9/18/2025
4.10.0-beta-0013 429 9/18/2025
4.10.0-beta-0012 428 9/18/2025
4.10.0-beta-0011 407 9/16/2025
4.10.0-beta-0010 415 9/16/2025
4.10.0-beta-0009 290 9/10/2025
4.10.0-beta-0008 262 9/10/2025
4.10.0-beta-0007 277 9/9/2025
4.10.0-beta-0006 354 8/28/2025
4.10.0-beta-0005 244 8/22/2025
4.10.0-beta-0004 251 8/22/2025
4.10.0-beta-0003 282 8/18/2025
4.10.0-beta-0002 255 8/18/2025
4.10.0-beta-0001 217 7/29/2025
4.9.1 1,146 7/29/2025
4.9.0 331 7/26/2025
4.9.0-beta-0005 664 7/22/2025
4.9.0-beta-0004 665 7/22/2025
4.9.0-beta-0003 660 7/22/2025
4.9.0-beta-0002 619 7/21/2025
4.9.0-beta-0001 552 7/21/2025
4.8.0 485 7/18/2025
4.8.0-beta-0004 216 7/18/2025
4.8.0-beta-0003 288 7/14/2025
4.8.0-beta-0002 275 7/14/2025
4.8.0-beta-0001 272 7/14/2025
4.7.0 544 6/25/2025
4.7.0-beta-0026 268 7/13/2025
4.7.0-beta-0025 264 7/10/2025
4.7.0-beta-0024 172 6/25/2025
4.7.0-beta-0023 266 6/25/2025
4.7.0-beta-0022 276 6/24/2025
4.7.0-beta-0021 287 6/23/2025
4.7.0-beta-0020 277 6/19/2025
4.7.0-beta-0004 283 6/19/2025
4.6.6 316 6/19/2025
4.6.5 280 6/19/2025
4.6.4 282 6/19/2025
4.6.3 603 6/18/2025
4.6.2 300 6/18/2025
4.6.1 325 6/16/2025
4.6.1-beta-0005 290 6/18/2025
4.6.1-beta-0003 267 6/18/2025
4.6.1-beta-0001 286 6/16/2025
4.6.0 296 6/16/2025
4.5.0 485 6/10/2025
4.5.0-beta-0007 425 6/10/2025
4.5.0-beta-0006 390 6/9/2025
4.5.0-beta-0004 250 6/6/2025
4.5.0-beta-0002 284 6/6/2025
4.4.0 534 6/3/2025
4.4.0-beta-0025 284 6/3/2025
4.4.0-beta-0023 279 5/29/2025
4.4.0-beta-0021 288 5/29/2025
4.4.0-beta-0018 294 5/26/2025
4.4.0-beta-0017 298 5/26/2025
4.4.0-beta-0015 280 5/26/2025
4.4.0-beta-0014 277 5/26/2025
4.4.0-beta-0004 255 5/25/2025
4.2.2 591 5/24/2025
4.2.1 479 5/8/2025
4.2.0 447 4/25/2025
4.2.0-beta-0010 317 5/8/2025
4.2.0-beta-0009 302 5/8/2025
4.2.0-beta-0008 278 4/25/2025
4.2.0-beta-0001 361 4/16/2025
4.1.0 632 3/28/2025
4.1.0-beta-0001 299 3/28/2025
4.0.4 608 3/24/2025
4.0.4-beta-0001 585 3/24/2025
4.0.3 407 3/23/2025
4.0.3-beta-0007 414 3/23/2025
4.0.2 409 3/15/2025
4.0.1 534 3/5/2025
4.0.1-beta-0010 327 3/19/2025
4.0.1-beta-0009 227 3/15/2025
4.0.1-beta-0001 380 3/5/2025
4.0.0 380 3/4/2025
4.0.0-beta-0021 376 3/4/2025
4.0.0-beta-0017 375 3/4/2025
4.0.0-beta-0016 384 3/4/2025
4.0.0-beta-0010 239 3/2/2025
4.0.0-beta-0009 249 3/2/2025
4.0.0-beta-0002 282 3/1/2025
3.3.1 427 2/20/2025
3.3.0 261 2/20/2025
3.3.0-beta-0028 244 2/20/2025
3.3.0-beta-0025 280 2/19/2025
3.3.0-beta-0024 312 2/19/2025
3.3.0-beta-0004 250 2/8/2025
3.2.0 540 1/29/2025
3.2.0-beta-0027 241 1/29/2025
3.2.0-beta-0023 224 1/29/2025
3.2.0-beta-0020 247 1/29/2025
3.1.3 233 1/29/2025
3.1.2 258 1/28/2025
3.1.1 270 1/25/2025
3.1.0 236 1/25/2025
3.1.0-beta-0013 249 1/25/2025
3.1.0-beta-0006 228 1/25/2025
3.1.0-beta-0004 203 1/25/2025
3.0.0 230 1/24/2025
3.0.0-beta-0055 247 1/24/2025
3.0.0-beta-0046 243 1/23/2025
3.0.0-beta-0045 227 1/23/2025
3.0.0-beta-0043 258 1/23/2025
3.0.0-beta-0038 258 1/21/2025
3.0.0-beta-0037 229 1/21/2025
3.0.0-beta-0029 250 1/21/2025
3.0.0-beta-0028 247 1/21/2025
3.0.0-beta-0018 223 1/19/2025
3.0.0-beta-0016 216 1/14/2025
3.0.0-beta-0012 229 1/12/2025
3.0.0-beta-0008 259 1/2/2025
3.0.0-beta-0007 222 12/28/2024
3.0.0-beta-0004 204 12/22/2024
2.2.0-beta-0001 459 10/28/2024
2.1.1 905 10/28/2024
2.1.0 377 10/19/2024
2.1.0-beta-0016 239 10/19/2024
2.1.0-beta-0015 253 10/19/2024
2.1.0-beta-0014 265 10/19/2024
2.1.0-beta-0013 271 10/19/2024
2.1.0-beta-0011 264 10/18/2024
2.1.0-beta-0010 252 10/18/2024
2.1.0-beta-0004 259 10/8/2024
2.1.0-beta-0002 224 10/6/2024
2.0.2 511 10/6/2024
2.0.1 250 10/6/2024
2.0.0 368 10/4/2024
2.0.0-beta-0060 242 10/6/2024
2.0.0-beta-0059 214 10/6/2024
2.0.0-beta-0056 242 10/4/2024
2.0.0-beta-0054 256 10/3/2024
2.0.0-beta-0053 252 10/2/2024
2.0.0-beta-0052 255 10/2/2024
2.0.0-beta-0050 233 10/2/2024
2.0.0-beta-0049 250 10/2/2024
2.0.0-beta-0046 262 10/1/2024
2.0.0-beta-0044 249 9/30/2024
2.0.0-beta-0026 262 9/24/2024
2.0.0-beta-0023 258 9/23/2024
2.0.0-beta-0022 213 9/23/2024
2.0.0-beta-0020 218 9/22/2024
2.0.0-beta-0004 213 9/20/2024
2.0.0-beta-0003 250 9/20/2024
1.9.0-beta-0003 253 9/16/2024
1.9.0-beta-0001 256 9/15/2024
1.9.0-beta 256 9/15/2024
1.8.1 428 9/14/2024
1.8.1-beta-0006 253 9/14/2024
1.8.1-beta-0005 227 9/14/2024
1.8.1-beta-0004 255 9/14/2024
1.8.1-beta-0003 226 9/14/2024
1.8.1-beta-0002 243 9/14/2024
1.8.1-beta-0001 229 9/14/2024
1.8.0 303 9/12/2024
1.8.0-beta-0064 252 9/12/2024
1.8.0-beta-0063 254 9/12/2024
1.8.0-beta-0059 250 9/8/2024
1.8.0-beta-0058 235 9/8/2024
1.8.0-beta-0057 278 9/8/2024
1.8.0-beta-0054 260 9/7/2024
1.8.0-beta-0053 277 9/6/2024
1.8.0-beta-0052 261 9/6/2024
1.8.0-beta-0051 247 9/6/2024
1.8.0-beta-0044 275 9/5/2024
1.8.0-beta-0042 274 9/4/2024
1.8.0-beta-0041 252 9/4/2024
1.8.0-beta-0027 277 8/25/2024
1.8.0-beta-0022 262 8/23/2024
1.8.0-beta-0017 251 8/7/2024
1.8.0-beta-0012 215 7/28/2024
1.8.0-beta-0010 176 7/28/2024
1.7.5 323 8/23/2024
1.7.4 413 8/9/2024
1.7.3 262 8/7/2024
1.7.2 248 7/28/2024
1.7.1 203 7/28/2024
1.7.0 287 7/20/2024
1.7.0-beta-0005 208 7/20/2024
1.7.0-beta-0001 235 7/8/2024
1.6.0 275 7/8/2024
1.6.0-beta-0004 219 7/7/2024
1.5.0 243 7/6/2024
1.5.0-beta-0010 229 7/6/2024
1.5.0-beta-0006 225 7/4/2024
1.4.5 220 7/4/2024
1.4.2 259 6/30/2024
1.4.1 258 6/30/2024
1.4.0 247 6/30/2024
1.4.0-beta-0010 240 6/30/2024
1.3.1 256 6/29/2024
1.3.0 235 6/29/2024
1.3.0-beta-0014 216 6/29/2024
1.3.0-beta-0007 199 6/26/2024
1.2.0 227 6/20/2024
1.2.0-beta-0001 197 6/20/2024
1.1.0 237 6/17/2024
1.1.0-beta-0019 206 6/20/2024
1.1.0-beta-0016 209 6/19/2024
1.1.0-beta-0014 182 6/17/2024
1.1.0-beta-0013 211 6/17/2024
1.0.0 269 6/15/2024
1.0.0-alpha-0054 182 6/15/2024
1.0.0-alpha-0053 215 6/12/2024
1.0.0-alpha-0051 178 6/12/2024
1.0.0-alpha-0048 196 6/10/2024
1.0.0-alpha-0047 189 6/10/2024
1.0.0-alpha-0043 166 6/9/2024
1.0.0-alpha-0042 240 6/7/2024
1.0.0-alpha-0040 202 6/6/2024
1.0.0-alpha-0038 191 6/6/2024
1.0.0-alpha-0036 186 6/5/2024
1.0.0-alpha-0034 193 6/4/2024
1.0.0-alpha-0031 170 6/4/2024
1.0.0-alpha-0025 171 6/3/2024
1.0.0-alpha-0023 207 6/2/2024
1.0.0-alpha-0022 190 6/1/2024
1.0.0-alpha-0019 198 6/1/2024
1.0.0-alpha-0018 182 6/1/2024
1.0.0-alpha-0014 183 6/1/2024
1.0.0-alpha-0013 174 6/1/2024
1.0.0-alpha-0012 179 5/31/2024
1.0.0-alpha-0011 168 5/31/2024
1.0.0-alpha-0010 153 5/31/2024