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.0.0-beta-0001 53 10/7/2025
4.10.0-beta-0020 359 9/19/2025
4.10.0-beta-0019 426 9/18/2025
4.10.0-beta-0018 416 9/18/2025
4.10.0-beta-0017 420 9/18/2025
4.10.0-beta-0016 418 9/18/2025
4.10.0-beta-0015 409 9/18/2025
4.10.0-beta-0014 412 9/18/2025
4.10.0-beta-0013 414 9/18/2025
4.10.0-beta-0012 411 9/18/2025
4.10.0-beta-0011 387 9/16/2025
4.10.0-beta-0010 397 9/16/2025
4.10.0-beta-0009 275 9/10/2025
4.10.0-beta-0008 245 9/10/2025
4.10.0-beta-0007 258 9/9/2025
4.10.0-beta-0006 337 8/28/2025
4.10.0-beta-0005 224 8/22/2025
4.10.0-beta-0004 235 8/22/2025
4.10.0-beta-0003 263 8/18/2025
4.10.0-beta-0002 237 8/18/2025
4.10.0-beta-0001 215 7/29/2025
4.9.1 793 7/29/2025
4.9.0 328 7/26/2025
4.9.0-beta-0005 661 7/22/2025
4.9.0-beta-0004 661 7/22/2025
4.9.0-beta-0003 657 7/22/2025
4.9.0-beta-0002 615 7/21/2025
4.9.0-beta-0001 545 7/21/2025
4.8.0 398 7/18/2025
4.8.0-beta-0004 211 7/18/2025
4.8.0-beta-0003 283 7/14/2025
4.8.0-beta-0002 269 7/14/2025
4.8.0-beta-0001 266 7/14/2025
4.7.0 530 6/25/2025
4.7.0-beta-0026 261 7/13/2025
4.7.0-beta-0025 262 7/10/2025
4.7.0-beta-0024 170 6/25/2025
4.7.0-beta-0023 262 6/25/2025
4.7.0-beta-0022 270 6/24/2025
4.7.0-beta-0021 276 6/23/2025
4.7.0-beta-0020 273 6/19/2025
4.7.0-beta-0004 280 6/19/2025
4.6.6 301 6/19/2025
4.6.5 275 6/19/2025
4.6.4 277 6/19/2025
4.6.3 593 6/18/2025
4.6.2 292 6/18/2025
4.6.1 315 6/16/2025
4.6.1-beta-0005 281 6/18/2025
4.6.1-beta-0003 261 6/18/2025
4.6.1-beta-0001 276 6/16/2025
4.6.0 291 6/16/2025
4.5.0 475 6/10/2025
4.5.0-beta-0007 416 6/10/2025
4.5.0-beta-0006 386 6/9/2025
4.5.0-beta-0004 238 6/6/2025
4.5.0-beta-0002 269 6/6/2025
4.4.0 523 6/3/2025
4.4.0-beta-0025 274 6/3/2025
4.4.0-beta-0023 273 5/29/2025
4.4.0-beta-0021 278 5/29/2025
4.4.0-beta-0018 287 5/26/2025
4.4.0-beta-0017 290 5/26/2025
4.4.0-beta-0015 272 5/26/2025
4.4.0-beta-0014 266 5/26/2025
4.4.0-beta-0004 249 5/25/2025
4.2.2 577 5/24/2025
4.2.1 468 5/8/2025
4.2.0 429 4/25/2025
4.2.0-beta-0010 306 5/8/2025
4.2.0-beta-0009 298 5/8/2025
4.2.0-beta-0008 269 4/25/2025
4.2.0-beta-0001 350 4/16/2025
4.1.0 616 3/28/2025
4.1.0-beta-0001 291 3/28/2025
4.0.4 595 3/24/2025
4.0.4-beta-0001 570 3/24/2025
4.0.3 400 3/23/2025
4.0.3-beta-0007 408 3/23/2025
4.0.2 394 3/15/2025
4.0.1 523 3/5/2025
4.0.1-beta-0010 314 3/19/2025
4.0.1-beta-0009 217 3/15/2025
4.0.1-beta-0001 364 3/5/2025
4.0.0 368 3/4/2025
4.0.0-beta-0021 368 3/4/2025
4.0.0-beta-0017 365 3/4/2025
4.0.0-beta-0016 369 3/4/2025
4.0.0-beta-0010 236 3/2/2025
4.0.0-beta-0009 247 3/2/2025
4.0.0-beta-0002 273 3/1/2025
3.3.1 419 2/20/2025
3.3.0 256 2/20/2025
3.3.0-beta-0028 237 2/20/2025
3.3.0-beta-0025 271 2/19/2025
3.3.0-beta-0024 300 2/19/2025
3.3.0-beta-0004 243 2/8/2025
3.2.0 526 1/29/2025
3.2.0-beta-0027 232 1/29/2025
3.2.0-beta-0023 218 1/29/2025
3.2.0-beta-0020 239 1/29/2025
3.1.3 231 1/29/2025
3.1.2 248 1/28/2025
3.1.1 262 1/25/2025
3.1.0 229 1/25/2025
3.1.0-beta-0013 237 1/25/2025
3.1.0-beta-0006 216 1/25/2025
3.1.0-beta-0004 200 1/25/2025
3.0.0 225 1/24/2025
3.0.0-beta-0055 240 1/24/2025
3.0.0-beta-0046 228 1/23/2025
3.0.0-beta-0045 223 1/23/2025
3.0.0-beta-0043 248 1/23/2025
3.0.0-beta-0038 250 1/21/2025
3.0.0-beta-0037 224 1/21/2025
3.0.0-beta-0029 238 1/21/2025
3.0.0-beta-0028 239 1/21/2025
3.0.0-beta-0018 215 1/19/2025
3.0.0-beta-0016 209 1/14/2025
3.0.0-beta-0012 218 1/12/2025
3.0.0-beta-0008 251 1/2/2025
3.0.0-beta-0007 219 12/28/2024
3.0.0-beta-0004 201 12/22/2024
2.2.0-beta-0001 441 10/28/2024
2.1.1 870 10/28/2024
2.1.0 374 10/19/2024
2.1.0-beta-0016 229 10/19/2024
2.1.0-beta-0015 247 10/19/2024
2.1.0-beta-0014 258 10/19/2024
2.1.0-beta-0013 257 10/19/2024
2.1.0-beta-0011 261 10/18/2024
2.1.0-beta-0010 246 10/18/2024
2.1.0-beta-0004 249 10/8/2024
2.1.0-beta-0002 221 10/6/2024
2.0.2 508 10/6/2024
2.0.1 248 10/6/2024
2.0.0 351 10/4/2024
2.0.0-beta-0060 237 10/6/2024
2.0.0-beta-0059 211 10/6/2024
2.0.0-beta-0056 229 10/4/2024
2.0.0-beta-0054 246 10/3/2024
2.0.0-beta-0053 240 10/2/2024
2.0.0-beta-0052 245 10/2/2024
2.0.0-beta-0050 230 10/2/2024
2.0.0-beta-0049 243 10/2/2024
2.0.0-beta-0046 252 10/1/2024
2.0.0-beta-0044 243 9/30/2024
2.0.0-beta-0026 252 9/24/2024
2.0.0-beta-0023 248 9/23/2024
2.0.0-beta-0022 210 9/23/2024
2.0.0-beta-0020 212 9/22/2024
2.0.0-beta-0004 210 9/20/2024
2.0.0-beta-0003 242 9/20/2024
1.9.0-beta-0003 242 9/16/2024
1.9.0-beta-0001 246 9/15/2024
1.9.0-beta 245 9/15/2024
1.8.1 421 9/14/2024
1.8.1-beta-0006 241 9/14/2024
1.8.1-beta-0005 213 9/14/2024
1.8.1-beta-0004 245 9/14/2024
1.8.1-beta-0003 224 9/14/2024
1.8.1-beta-0002 232 9/14/2024
1.8.1-beta-0001 222 9/14/2024
1.8.0 296 9/12/2024
1.8.0-beta-0064 241 9/12/2024
1.8.0-beta-0063 251 9/12/2024
1.8.0-beta-0059 243 9/8/2024
1.8.0-beta-0058 231 9/8/2024
1.8.0-beta-0057 265 9/8/2024
1.8.0-beta-0054 255 9/7/2024
1.8.0-beta-0053 267 9/6/2024
1.8.0-beta-0052 250 9/6/2024
1.8.0-beta-0051 244 9/6/2024
1.8.0-beta-0044 268 9/5/2024
1.8.0-beta-0042 267 9/4/2024
1.8.0-beta-0041 247 9/4/2024
1.8.0-beta-0027 270 8/25/2024
1.8.0-beta-0022 254 8/23/2024
1.8.0-beta-0017 244 8/7/2024
1.8.0-beta-0012 204 7/28/2024
1.8.0-beta-0010 173 7/28/2024
1.7.5 314 8/23/2024
1.7.4 410 8/9/2024
1.7.3 259 8/7/2024
1.7.2 238 7/28/2024
1.7.1 199 7/28/2024
1.7.0 277 7/20/2024
1.7.0-beta-0005 205 7/20/2024
1.7.0-beta-0001 220 7/8/2024
1.6.0 272 7/8/2024
1.6.0-beta-0004 216 7/7/2024
1.5.0 239 7/6/2024
1.5.0-beta-0010 217 7/6/2024
1.5.0-beta-0006 218 7/4/2024
1.4.5 215 7/4/2024
1.4.2 250 6/30/2024
1.4.1 249 6/30/2024
1.4.0 236 6/30/2024
1.4.0-beta-0010 234 6/30/2024
1.3.1 243 6/29/2024
1.3.0 220 6/29/2024
1.3.0-beta-0014 205 6/29/2024
1.3.0-beta-0007 192 6/26/2024
1.2.0 218 6/20/2024
1.2.0-beta-0001 185 6/20/2024
1.1.0 227 6/17/2024
1.1.0-beta-0019 197 6/20/2024
1.1.0-beta-0016 202 6/19/2024
1.1.0-beta-0014 179 6/17/2024
1.1.0-beta-0013 200 6/17/2024
1.0.0 251 6/15/2024
1.0.0-alpha-0054 176 6/15/2024
1.0.0-alpha-0053 201 6/12/2024
1.0.0-alpha-0051 167 6/12/2024
1.0.0-alpha-0048 191 6/10/2024
1.0.0-alpha-0047 178 6/10/2024
1.0.0-alpha-0043 162 6/9/2024
1.0.0-alpha-0042 228 6/7/2024
1.0.0-alpha-0040 194 6/6/2024
1.0.0-alpha-0038 183 6/6/2024
1.0.0-alpha-0036 181 6/5/2024
1.0.0-alpha-0034 186 6/4/2024
1.0.0-alpha-0031 163 6/4/2024
1.0.0-alpha-0025 162 6/3/2024
1.0.0-alpha-0023 195 6/2/2024
1.0.0-alpha-0022 186 6/1/2024
1.0.0-alpha-0019 190 6/1/2024
1.0.0-alpha-0018 178 6/1/2024
1.0.0-alpha-0014 180 6/1/2024
1.0.0-alpha-0013 165 6/1/2024
1.0.0-alpha-0012 171 5/31/2024
1.0.0-alpha-0011 158 5/31/2024
1.0.0-alpha-0010 146 5/31/2024