Shiny.Mediator 1.0.0-alpha-0031

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

Shiny Mediator (Preview)

PLEASE NOTE - THIS IS AN ALPHA. THINGS ARE LIKELY TO CHANGE

<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 subscriptions 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

First, let's install Shiny.Mediator.Maui Now...let's go back to our MauiProgram.cs and alter the AddShinyMediator

builder.Services.AddShinyMediator(cfg => cfg.UseMaui());

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 Request & Events

  • 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

  • Document
    • Event Collectors
    • Request Middleware
    • Covariance Event Handlers & Request Middleware
    • OOBE Middleware
  • Event Collectors for MAUI execute on main thread?
  • 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
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.FluentValidation

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 284 9/19/2025
4.10.0-beta-0019 350 9/18/2025
4.10.0-beta-0018 344 9/18/2025
4.10.0-beta-0017 347 9/18/2025
4.10.0-beta-0016 346 9/18/2025
4.10.0-beta-0015 338 9/18/2025
4.10.0-beta-0014 345 9/18/2025
4.10.0-beta-0013 348 9/18/2025
4.10.0-beta-0012 341 9/18/2025
4.10.0-beta-0011 328 9/16/2025
4.10.0-beta-0010 342 9/16/2025
4.10.0-beta-0009 203 9/10/2025
4.10.0-beta-0008 186 9/10/2025
4.10.0-beta-0007 189 9/9/2025
4.10.0-beta-0006 263 8/28/2025
4.10.0-beta-0005 155 8/22/2025
4.10.0-beta-0004 179 8/22/2025
4.10.0-beta-0003 188 8/18/2025
4.10.0-beta-0002 188 8/18/2025
4.10.0-beta-0001 149 7/29/2025
4.9.1 663 7/29/2025
4.9.0 259 7/26/2025
4.9.0-beta-0005 598 7/22/2025
4.9.0-beta-0004 597 7/22/2025
4.9.0-beta-0003 594 7/22/2025
4.9.0-beta-0002 557 7/21/2025
4.9.0-beta-0001 483 7/21/2025
4.8.0 318 7/18/2025
4.8.0-beta-0004 151 7/18/2025
4.8.0-beta-0003 227 7/14/2025
4.8.0-beta-0002 211 7/14/2025
4.8.0-beta-0001 206 7/14/2025
4.7.0 474 6/25/2025
4.7.0-beta-0026 202 7/13/2025
4.7.0-beta-0025 212 7/10/2025
4.7.0-beta-0024 141 6/25/2025
4.7.0-beta-0023 213 6/25/2025
4.7.0-beta-0022 211 6/24/2025
4.7.0-beta-0021 221 6/23/2025
4.7.0-beta-0020 216 6/19/2025
4.7.0-beta-0004 219 6/19/2025
4.6.6 234 6/19/2025
4.6.5 220 6/19/2025
4.6.4 218 6/19/2025
4.6.3 533 6/18/2025
4.6.2 231 6/18/2025
4.6.1 255 6/16/2025
4.6.1-beta-0005 227 6/18/2025
4.6.1-beta-0003 214 6/18/2025
4.6.1-beta-0001 217 6/16/2025
4.6.0 233 6/16/2025
4.5.0 428 6/10/2025
4.5.0-beta-0007 362 6/10/2025
4.5.0-beta-0006 330 6/9/2025
4.5.0-beta-0004 179 6/6/2025
4.5.0-beta-0002 212 6/6/2025
4.4.0 473 6/3/2025
4.4.0-beta-0025 219 6/3/2025
4.4.0-beta-0023 214 5/29/2025
4.4.0-beta-0021 221 5/29/2025
4.4.0-beta-0018 226 5/26/2025
4.4.0-beta-0017 230 5/26/2025
4.4.0-beta-0015 221 5/26/2025
4.4.0-beta-0014 217 5/26/2025
4.4.0-beta-0004 187 5/25/2025
4.2.2 514 5/24/2025
4.2.1 399 5/8/2025
4.2.0 359 4/25/2025
4.2.0-beta-0010 236 5/8/2025
4.2.0-beta-0009 232 5/8/2025
4.2.0-beta-0008 202 4/25/2025
4.2.0-beta-0001 282 4/16/2025
4.1.0 546 3/28/2025
4.1.0-beta-0001 223 3/28/2025
4.0.4 526 3/24/2025
4.0.4-beta-0001 501 3/24/2025
4.0.3 350 3/23/2025
4.0.3-beta-0007 341 3/23/2025
4.0.2 326 3/15/2025
4.0.1 469 3/5/2025
4.0.1-beta-0010 244 3/19/2025
4.0.1-beta-0009 159 3/15/2025
4.0.1-beta-0001 308 3/5/2025
4.0.0 313 3/4/2025
4.0.0-beta-0021 302 3/4/2025
4.0.0-beta-0017 298 3/4/2025
4.0.0-beta-0016 300 3/4/2025
4.0.0-beta-0010 179 3/2/2025
4.0.0-beta-0009 179 3/2/2025
4.0.0-beta-0002 201 3/1/2025
3.3.1 373 2/20/2025
3.3.0 193 2/20/2025
3.3.0-beta-0028 178 2/20/2025
3.3.0-beta-0025 206 2/19/2025
3.3.0-beta-0024 234 2/19/2025
3.3.0-beta-0004 176 2/8/2025
3.2.0 465 1/29/2025
3.2.0-beta-0027 171 1/29/2025
3.2.0-beta-0023 181 1/29/2025
3.2.0-beta-0020 178 1/29/2025
3.1.3 174 1/29/2025
3.1.2 190 1/28/2025
3.1.1 194 1/25/2025
3.1.0 173 1/25/2025
3.1.0-beta-0013 174 1/25/2025
3.1.0-beta-0006 168 1/25/2025
3.1.0-beta-0004 158 1/25/2025
3.0.0 172 1/24/2025
3.0.0-beta-0055 180 1/24/2025
3.0.0-beta-0046 169 1/23/2025
3.0.0-beta-0045 165 1/23/2025
3.0.0-beta-0043 191 1/23/2025
3.0.0-beta-0038 191 1/21/2025
3.0.0-beta-0037 165 1/21/2025
3.0.0-beta-0029 181 1/21/2025
3.0.0-beta-0028 179 1/21/2025
3.0.0-beta-0018 165 1/19/2025
3.0.0-beta-0016 151 1/14/2025
3.0.0-beta-0012 167 1/12/2025
3.0.0-beta-0008 192 1/2/2025
3.0.0-beta-0007 166 12/28/2024
3.0.0-beta-0004 161 12/22/2024
2.2.0-beta-0001 394 10/28/2024
2.1.1 810 10/28/2024
2.1.0 324 10/19/2024
2.1.0-beta-0016 173 10/19/2024
2.1.0-beta-0015 180 10/19/2024
2.1.0-beta-0014 198 10/19/2024
2.1.0-beta-0013 198 10/19/2024
2.1.0-beta-0011 201 10/18/2024
2.1.0-beta-0010 185 10/18/2024
2.1.0-beta-0004 189 10/8/2024
2.1.0-beta-0002 175 10/6/2024
2.0.2 448 10/6/2024
2.0.1 197 10/6/2024
2.0.0 290 10/4/2024
2.0.0-beta-0060 180 10/6/2024
2.0.0-beta-0059 167 10/6/2024
2.0.0-beta-0056 171 10/4/2024
2.0.0-beta-0054 179 10/3/2024
2.0.0-beta-0053 180 10/2/2024
2.0.0-beta-0052 185 10/2/2024
2.0.0-beta-0050 183 10/2/2024
2.0.0-beta-0049 186 10/2/2024
2.0.0-beta-0046 196 10/1/2024
2.0.0-beta-0044 190 9/30/2024
2.0.0-beta-0026 193 9/24/2024
2.0.0-beta-0023 184 9/23/2024
2.0.0-beta-0022 160 9/23/2024
2.0.0-beta-0020 161 9/22/2024
2.0.0-beta-0004 166 9/20/2024
2.0.0-beta-0003 190 9/20/2024
1.9.0-beta-0003 190 9/16/2024
1.9.0-beta-0001 188 9/15/2024
1.9.0-beta 196 9/15/2024
1.8.1 376 9/14/2024
1.8.1-beta-0006 190 9/14/2024
1.8.1-beta-0005 171 9/14/2024
1.8.1-beta-0004 189 9/14/2024
1.8.1-beta-0003 175 9/14/2024
1.8.1-beta-0002 182 9/14/2024
1.8.1-beta-0001 176 9/14/2024
1.8.0 248 9/12/2024
1.8.0-beta-0064 193 9/12/2024
1.8.0-beta-0063 202 9/12/2024
1.8.0-beta-0059 204 9/8/2024
1.8.0-beta-0058 183 9/8/2024
1.8.0-beta-0057 207 9/8/2024
1.8.0-beta-0054 204 9/7/2024
1.8.0-beta-0053 215 9/6/2024
1.8.0-beta-0052 199 9/6/2024
1.8.0-beta-0051 197 9/6/2024
1.8.0-beta-0044 222 9/5/2024
1.8.0-beta-0042 205 9/4/2024
1.8.0-beta-0041 206 9/4/2024
1.8.0-beta-0027 215 8/25/2024
1.8.0-beta-0022 213 8/23/2024
1.8.0-beta-0017 204 8/7/2024
1.8.0-beta-0012 156 7/28/2024
1.8.0-beta-0010 137 7/28/2024
1.7.5 266 8/23/2024
1.7.4 372 8/9/2024
1.7.3 215 8/7/2024
1.7.2 199 7/28/2024
1.7.1 158 7/28/2024
1.7.0 227 7/20/2024
1.7.0-beta-0005 153 7/20/2024
1.7.0-beta-0001 172 7/8/2024
1.6.0 221 7/8/2024
1.6.0-beta-0004 168 7/7/2024
1.5.0 202 7/6/2024
1.5.0-beta-0010 177 7/6/2024
1.5.0-beta-0006 174 7/4/2024
1.4.5 186 7/4/2024
1.4.2 204 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 188 6/29/2024
1.3.0-beta-0014 176 6/29/2024
1.3.0-beta-0007 158 6/26/2024
1.2.0 191 6/20/2024
1.2.0-beta-0001 148 6/20/2024
1.1.0 191 6/17/2024
1.1.0-beta-0019 164 6/20/2024
1.1.0-beta-0016 169 6/19/2024
1.1.0-beta-0014 158 6/17/2024
1.1.0-beta-0013 164 6/17/2024
1.0.0 222 6/15/2024
1.0.0-alpha-0054 148 6/15/2024
1.0.0-alpha-0053 166 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 166 6/6/2024
1.0.0-alpha-0038 163 6/6/2024
1.0.0-alpha-0036 149 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 158 6/1/2024
1.0.0-alpha-0019 161 6/1/2024
1.0.0-alpha-0018 154 6/1/2024
1.0.0-alpha-0014 148 6/1/2024
1.0.0-alpha-0013 142 6/1/2024
1.0.0-alpha-0012 147 5/31/2024
1.0.0-alpha-0011 136 5/31/2024
1.0.0-alpha-0010 134 5/31/2024