Shiny.Mediator 1.0.0-alpha-0022

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

This project is heavily inspired by MediatR with some lesser features that we feel were aimed more at server scenarios, while also adding some features we feel benefit apps

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
  • 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! (WIP)
  • 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
        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!

Request Middleware Ideas

  • Connectivity check - pull from cache/memory or go to the API

TODO

  • Explain Event Collectors
  • 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?
  • Request Middleware - Covariance/catch-all
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-0004 255 10/10/2025
5.0.0-beta-0003 276 10/9/2025
5.0.0-beta-0002 280 10/8/2025
5.0.0-beta-0001 298 10/7/2025
4.10.0-beta-0020 364 9/19/2025
4.10.0-beta-0019 427 9/18/2025
4.10.0-beta-0018 417 9/18/2025
4.10.0-beta-0017 421 9/18/2025
4.10.0-beta-0016 420 9/18/2025
4.10.0-beta-0015 410 9/18/2025
4.10.0-beta-0014 414 9/18/2025
4.10.0-beta-0013 415 9/18/2025
4.10.0-beta-0012 414 9/18/2025
4.10.0-beta-0011 388 9/16/2025
4.10.0-beta-0010 398 9/16/2025
4.10.0-beta-0009 276 9/10/2025
4.10.0-beta-0008 246 9/10/2025
4.10.0-beta-0007 259 9/9/2025
4.10.0-beta-0006 341 8/28/2025
4.10.0-beta-0005 225 8/22/2025
4.10.0-beta-0004 236 8/22/2025
4.10.0-beta-0003 264 8/18/2025
4.10.0-beta-0002 238 8/18/2025
4.10.0-beta-0001 216 7/29/2025
4.9.1 927 7/29/2025
4.9.0 329 7/26/2025
4.9.0-beta-0005 662 7/22/2025
4.9.0-beta-0004 663 7/22/2025
4.9.0-beta-0003 658 7/22/2025
4.9.0-beta-0002 617 7/21/2025
4.9.0-beta-0001 547 7/21/2025
4.8.0 420 7/18/2025
4.8.0-beta-0004 213 7/18/2025
4.8.0-beta-0003 286 7/14/2025
4.8.0-beta-0002 272 7/14/2025
4.8.0-beta-0001 269 7/14/2025
4.7.0 535 6/25/2025
4.7.0-beta-0026 262 7/13/2025
4.7.0-beta-0025 263 7/10/2025
4.7.0-beta-0024 171 6/25/2025
4.7.0-beta-0023 264 6/25/2025
4.7.0-beta-0022 271 6/24/2025
4.7.0-beta-0021 279 6/23/2025
4.7.0-beta-0020 276 6/19/2025
4.7.0-beta-0004 281 6/19/2025
4.6.6 308 6/19/2025
4.6.5 277 6/19/2025
4.6.4 278 6/19/2025
4.6.3 596 6/18/2025
4.6.2 296 6/18/2025
4.6.1 317 6/16/2025
4.6.1-beta-0005 287 6/18/2025
4.6.1-beta-0003 262 6/18/2025
4.6.1-beta-0001 282 6/16/2025
4.6.0 293 6/16/2025
4.5.0 481 6/10/2025
4.5.0-beta-0007 419 6/10/2025
4.5.0-beta-0006 387 6/9/2025
4.5.0-beta-0004 243 6/6/2025
4.5.0-beta-0002 273 6/6/2025
4.4.0 525 6/3/2025
4.4.0-beta-0025 277 6/3/2025
4.4.0-beta-0023 274 5/29/2025
4.4.0-beta-0021 282 5/29/2025
4.4.0-beta-0018 291 5/26/2025
4.4.0-beta-0017 292 5/26/2025
4.4.0-beta-0015 275 5/26/2025
4.4.0-beta-0014 268 5/26/2025
4.4.0-beta-0004 251 5/25/2025
4.2.2 584 5/24/2025
4.2.1 475 5/8/2025
4.2.0 433 4/25/2025
4.2.0-beta-0010 309 5/8/2025
4.2.0-beta-0009 299 5/8/2025
4.2.0-beta-0008 273 4/25/2025
4.2.0-beta-0001 356 4/16/2025
4.1.0 621 3/28/2025
4.1.0-beta-0001 294 3/28/2025
4.0.4 601 3/24/2025
4.0.4-beta-0001 577 3/24/2025
4.0.3 401 3/23/2025
4.0.3-beta-0007 410 3/23/2025
4.0.2 398 3/15/2025
4.0.1 529 3/5/2025
4.0.1-beta-0010 316 3/19/2025
4.0.1-beta-0009 220 3/15/2025
4.0.1-beta-0001 367 3/5/2025
4.0.0 372 3/4/2025
4.0.0-beta-0021 371 3/4/2025
4.0.0-beta-0017 368 3/4/2025
4.0.0-beta-0016 373 3/4/2025
4.0.0-beta-0010 237 3/2/2025
4.0.0-beta-0009 248 3/2/2025
4.0.0-beta-0002 279 3/1/2025
3.3.1 422 2/20/2025
3.3.0 258 2/20/2025
3.3.0-beta-0028 238 2/20/2025
3.3.0-beta-0025 273 2/19/2025
3.3.0-beta-0024 303 2/19/2025
3.3.0-beta-0004 244 2/8/2025
3.2.0 531 1/29/2025
3.2.0-beta-0027 235 1/29/2025
3.2.0-beta-0023 221 1/29/2025
3.2.0-beta-0020 244 1/29/2025
3.1.3 232 1/29/2025
3.1.2 253 1/28/2025
3.1.1 264 1/25/2025
3.1.0 231 1/25/2025
3.1.0-beta-0013 244 1/25/2025
3.1.0-beta-0006 223 1/25/2025
3.1.0-beta-0004 201 1/25/2025
3.0.0 227 1/24/2025
3.0.0-beta-0055 243 1/24/2025
3.0.0-beta-0046 231 1/23/2025
3.0.0-beta-0045 224 1/23/2025
3.0.0-beta-0043 253 1/23/2025
3.0.0-beta-0038 254 1/21/2025
3.0.0-beta-0037 227 1/21/2025
3.0.0-beta-0029 240 1/21/2025
3.0.0-beta-0028 242 1/21/2025
3.0.0-beta-0018 219 1/19/2025
3.0.0-beta-0016 214 1/14/2025
3.0.0-beta-0012 221 1/12/2025
3.0.0-beta-0008 255 1/2/2025
3.0.0-beta-0007 221 12/28/2024
3.0.0-beta-0004 203 12/22/2024
2.2.0-beta-0001 454 10/28/2024
2.1.1 881 10/28/2024
2.1.0 375 10/19/2024
2.1.0-beta-0016 232 10/19/2024
2.1.0-beta-0015 252 10/19/2024
2.1.0-beta-0014 263 10/19/2024
2.1.0-beta-0013 262 10/19/2024
2.1.0-beta-0011 262 10/18/2024
2.1.0-beta-0010 248 10/18/2024
2.1.0-beta-0004 253 10/8/2024
2.1.0-beta-0002 222 10/6/2024
2.0.2 509 10/6/2024
2.0.1 249 10/6/2024
2.0.0 357 10/4/2024
2.0.0-beta-0060 240 10/6/2024
2.0.0-beta-0059 212 10/6/2024
2.0.0-beta-0056 233 10/4/2024
2.0.0-beta-0054 251 10/3/2024
2.0.0-beta-0053 245 10/2/2024
2.0.0-beta-0052 250 10/2/2024
2.0.0-beta-0050 232 10/2/2024
2.0.0-beta-0049 244 10/2/2024
2.0.0-beta-0046 255 10/1/2024
2.0.0-beta-0044 244 9/30/2024
2.0.0-beta-0026 255 9/24/2024
2.0.0-beta-0023 250 9/23/2024
2.0.0-beta-0022 211 9/23/2024
2.0.0-beta-0020 213 9/22/2024
2.0.0-beta-0004 211 9/20/2024
2.0.0-beta-0003 245 9/20/2024
1.9.0-beta-0003 248 9/16/2024
1.9.0-beta-0001 252 9/15/2024
1.9.0-beta 253 9/15/2024
1.8.1 422 9/14/2024
1.8.1-beta-0006 246 9/14/2024
1.8.1-beta-0005 215 9/14/2024
1.8.1-beta-0004 250 9/14/2024
1.8.1-beta-0003 225 9/14/2024
1.8.1-beta-0002 234 9/14/2024
1.8.1-beta-0001 223 9/14/2024
1.8.0 300 9/12/2024
1.8.0-beta-0064 243 9/12/2024
1.8.0-beta-0063 253 9/12/2024
1.8.0-beta-0059 246 9/8/2024
1.8.0-beta-0058 234 9/8/2024
1.8.0-beta-0057 269 9/8/2024
1.8.0-beta-0054 258 9/7/2024
1.8.0-beta-0053 267 9/6/2024
1.8.0-beta-0052 256 9/6/2024
1.8.0-beta-0051 246 9/6/2024
1.8.0-beta-0044 270 9/5/2024
1.8.0-beta-0042 270 9/4/2024
1.8.0-beta-0041 249 9/4/2024
1.8.0-beta-0027 273 8/25/2024
1.8.0-beta-0022 259 8/23/2024
1.8.0-beta-0017 246 8/7/2024
1.8.0-beta-0012 208 7/28/2024
1.8.0-beta-0010 174 7/28/2024
1.7.5 319 8/23/2024
1.7.4 410 8/9/2024
1.7.3 260 8/7/2024
1.7.2 241 7/28/2024
1.7.1 201 7/28/2024
1.7.0 283 7/20/2024
1.7.0-beta-0005 206 7/20/2024
1.7.0-beta-0001 225 7/8/2024
1.6.0 273 7/8/2024
1.6.0-beta-0004 217 7/7/2024
1.5.0 241 7/6/2024
1.5.0-beta-0010 224 7/6/2024
1.5.0-beta-0006 221 7/4/2024
1.4.5 218 7/4/2024
1.4.2 253 6/30/2024
1.4.1 254 6/30/2024
1.4.0 240 6/30/2024
1.4.0-beta-0010 235 6/30/2024
1.3.1 247 6/29/2024
1.3.0 222 6/29/2024
1.3.0-beta-0014 210 6/29/2024
1.3.0-beta-0007 197 6/26/2024
1.2.0 223 6/20/2024
1.2.0-beta-0001 189 6/20/2024
1.1.0 231 6/17/2024
1.1.0-beta-0019 202 6/20/2024
1.1.0-beta-0016 205 6/19/2024
1.1.0-beta-0014 180 6/17/2024
1.1.0-beta-0013 205 6/17/2024
1.0.0 254 6/15/2024
1.0.0-alpha-0054 177 6/15/2024
1.0.0-alpha-0053 206 6/12/2024
1.0.0-alpha-0051 173 6/12/2024
1.0.0-alpha-0048 194 6/10/2024
1.0.0-alpha-0047 182 6/10/2024
1.0.0-alpha-0043 164 6/9/2024
1.0.0-alpha-0042 232 6/7/2024
1.0.0-alpha-0040 197 6/6/2024
1.0.0-alpha-0038 186 6/6/2024
1.0.0-alpha-0036 183 6/5/2024
1.0.0-alpha-0034 187 6/4/2024
1.0.0-alpha-0031 164 6/4/2024
1.0.0-alpha-0025 165 6/3/2024
1.0.0-alpha-0023 202 6/2/2024
1.0.0-alpha-0022 187 6/1/2024
1.0.0-alpha-0019 191 6/1/2024
1.0.0-alpha-0018 179 6/1/2024
1.0.0-alpha-0014 182 6/1/2024
1.0.0-alpha-0013 167 6/1/2024
1.0.0-alpha-0012 174 5/31/2024
1.0.0-alpha-0011 162 5/31/2024
1.0.0-alpha-0010 148 5/31/2024