Shiny.Mediator.AspNet 4.2.1

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator.AspNet --version 4.2.1
                    
NuGet\Install-Package Shiny.Mediator.AspNet -Version 4.2.1
                    
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.AspNet" Version="4.2.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shiny.Mediator.AspNet" Version="4.2.1" />
                    
Directory.Packages.props
<PackageReference Include="Shiny.Mediator.AspNet" />
                    
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.AspNet --version 4.2.1
                    
#r "nuget: Shiny.Mediator.AspNet, 4.2.1"
                    
#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.
#addin nuget:?package=Shiny.Mediator.AspNet&version=4.2.1
                    
Install Shiny.Mediator.AspNet as a Cake Addin
#tool nuget:?package=Shiny.Mediator.AspNet&version=4.2.1
                    
Install Shiny.Mediator.AspNet as a Cake Tool

Shiny Mediator

<a href="https://www.nuget.org/packages/Shiny.Mediator" target="_blank"> <img src="https://img.shields.io/nuget/v/Shiny.Mediator?style=for-the-badge" /> </a>

Mediator is a behavioral design pattern that lets you reduce chaotic dependencies between objects. The pattern restricts direct communications between the objects and forces them to collaborate only via a mediator object.

Shiny Mediator <NugetBadge name="Shiny.Mediator" /> is a mediator pattern implementation, but for built with ALL .NET apps in mind. We provide a TON of middleware out-of-box to get you up and rolling with hardly any effort whatsoever. Checkout our Getting Started guide to see how easy it is. Imagine using 1 line of code to add offline, caching, or validation to your code!

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

Samples & Documentation

Features

Works With

  • .NET MAUI - all platforms
  • MVVM Frameworks like Prism, ReactiveUI, & .NET MAUI Shell
  • Blazor - Work In Progress
  • Any other .NET platform - but you'll have to come up with your own "event collector" for the out-of-state stuff

What Does It Solve

Problem #1 - Service & Reference Hell

Does this look familiar to you? Look at all of those injections! As your app grows, the list will only grow. I feel sorry for the dude that gets to unit test this bad boy.

public class MyViewModel(
    IConnectivity conn,
    IDataService data,
    IAuthService auth,
    IDialogsService dialogs,
    ILogger<MyViewModel> logger
) {
    // ...
    try {
        if (conn.IsConnected) 
        {
            var myData = await data.GetDataRequest();
        }
        else 
        {
            dialogs.Show("No Connection");
            // cache?
        }
    }
    catch (Exception ex) {
        dialogs.Show(ex.Message);
        logger.LogError(ex);
    }
}

With a bit of our middleware and some events, you can get here:

public class MyViewModel(IMediator mediator) : IEventHandler<ConnectivityChangedEvent>, IEventHandler<AuthChangedEvent> {
    // ...
    var myData = await mediator.Request(new GetDataRequest());

    // logging, exception handling, offline caching can all be bundle into one nice clean call without the need for coupling
}

public class GetDataRequestHandler : IRequestHandler<GetDataRequest, MyData> {

    [OfflineAvailable] // <= boom done
    public async Task<MyData> Handle(GetDataRequest request, CancellationToken cancellationToken) {
        // ...
    }
}

Problem #2 - Messages EVERYWHERE (+ Leaks)

Do you use the MessagingCenter in Xamarin.Forms? It's a great tool, but it can lead to some memory leaks if you're not careful. It also doesn't have a pipeline, so any errors in any of the responders will crash the entire chain. It doesn't have a request/response style setup (not that it was meant for it), but this means you still require other services.

public class MyViewModel
{
    public MyViewModel()
    {
        MessagingCenter.Subscribe<SomeEvent1>(this, @event => {
            // do something
        });
        MessagingCenter.Subscribe<SomeEvent2>(this, @event => {
            // do something
        });

        MessagingCenter.Send(new SomeEvent1());
        MessagingCenter.Send(new SomeEvent2());

        // and don't forget to unsubscribe
        MessagingCenter.Unsubscribe<SomeEvent1>(this);
        MessagingCenter.Unsubscribe<SomeEvent2>(this);
    }
}

Let's take a look at our mediator in action for this scenarios

public class MyViewModel : IEventHandler<SomeEvent1>, IEventHandler<SomeEvent2>
{
    public MyViewModel(IMediator mediator)
    {
        // no need to unsubscribe
        mediator.Publish(new SomeEvent1());
        mediator.Publish(new SomeEvent2());
    }
}

Problem #3 - Strongly Typed Navigation with Strongly Typed Arguments

Our amazing friends over in Prism offer the "best in class" MVVM framework. We'll them upsell you beyond that, but one of their amazing features is 'Modules'. Modules help break up your navigation registration, services, etc.

What they don't solve is providing a strongly typed nature for this stuff (not their job though). We think we can help addon to their beautiful solution.

A normal call to a navigation service might look like this:

_navigationService.NavigateAsync("MyPage", new NavigationParameters { { "MyArg", "MyValue" } });

This is great. It works, but I don't know the type OR argument requirements of "MyPage" without going to look it up. In a small project with a small dev team, this is fine. In a large project with a large dev team, this can be difficult.

Through our Shiny.Framework library we offer a GlobalNavigationService that can be used to navigate to any page in your app from anywhere, however, for the nature of this example, we'll pass our navigation service FROM our viewmodel through the mediator request to ensure proper scope.

public record MyPageNavigatonRequest(INavigationService navigator, string MyArg) : IRequest;
public class MyPageNavigationHandler : IRequestHandler<MyPageNavigatonRequest>
{
    public async Task Handle(MyPageNavigatonRequest request, CancellationToken cancellationToken)
    {
        await request.navigator.NavigateAsync("MyPage", new NavigationParameters { { "MyArg", request.MyArg } });
    }
}

Now, in your viewmodel, you can do this:

public class MyViewModel
{
    public MyViewModel(IMediator mediator)
    {
        mediator.Request(new MyPageNavigationCommand(_navigationService, "MyValue"));
    }
}

Strongly typed. No page required page knowledge from the module upfront. The other dev team of the module can define HOW things work.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  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

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Shiny.Mediator.AspNet:

Repository Stars
shinyorg/templates
dotnet CLI & Visual Studio Templates
Version Downloads Last updated
4.4.0-beta-0023 107 5/29/2025
4.4.0-beta-0021 110 5/29/2025
4.4.0-beta-0018 124 5/26/2025
4.4.0-beta-0017 123 5/26/2025
4.4.0-beta-0015 128 5/26/2025
4.4.0-beta-0014 129 5/26/2025
4.4.0-beta-0004 75 5/25/2025
4.2.2 55 5/24/2025
4.2.1 138 5/8/2025
4.2.0 96 4/25/2025
4.2.0-beta-0010 128 5/8/2025
4.2.0-beta-0009 125 5/8/2025
4.2.0-beta-0008 90 4/25/2025
4.2.0-beta-0001 180 4/16/2025
4.1.0 129 3/28/2025
4.1.0-beta-0001 118 3/28/2025
4.0.4 401 3/24/2025
4.0.4-beta-0001 392 3/24/2025
4.0.3 257 3/23/2025
4.0.3-beta-0007 257 3/23/2025
4.0.2 68 3/15/2025
4.0.1 204 3/5/2025
4.0.1-beta-0010 134 3/19/2025
4.0.1-beta-0009 54 3/15/2025
4.0.1-beta-0001 195 3/5/2025
4.0.0 197 3/4/2025
4.0.0-beta-0021 189 3/4/2025
4.0.0-beta-0017 187 3/4/2025
4.0.0-beta-0016 197 3/4/2025
4.0.0-beta-0010 87 3/2/2025
4.0.0-beta-0009 80 3/2/2025
4.0.0-beta-0002 82 3/1/2025
3.3.1 100 2/20/2025
3.3.0 96 2/20/2025
3.3.0-beta-0028 93 2/20/2025
3.3.0-beta-0025 89 2/19/2025
3.3.0-beta-0024 86 2/19/2025
3.3.0-beta-0004 84 2/8/2025
3.2.0 87 1/29/2025
3.2.0-beta-0027 79 1/29/2025
3.2.0-beta-0023 88 1/29/2025
3.2.0-beta-0020 77 1/29/2025
3.1.3 90 1/29/2025
3.1.2 86 1/28/2025
3.1.1 94 1/25/2025
3.1.0 89 1/25/2025
3.1.0-beta-0013 81 1/25/2025
3.1.0-beta-0006 78 1/25/2025
3.1.0-beta-0004 86 1/25/2025
3.0.0 91 1/24/2025
3.0.0-beta-0055 73 1/24/2025
3.0.0-beta-0046 74 1/23/2025
3.0.0-beta-0045 85 1/23/2025
3.0.0-beta-0043 81 1/23/2025
3.0.0-beta-0038 92 1/21/2025
3.0.0-beta-0037 78 1/21/2025
3.0.0-beta-0029 87 1/21/2025
3.0.0-beta-0028 76 1/21/2025
3.0.0-beta-0018 72 1/19/2025
3.0.0-beta-0016 58 1/14/2025
3.0.0-beta-0012 71 1/12/2025
3.0.0-beta-0008 92 1/2/2025
3.0.0-beta-0007 82 12/28/2024
3.0.0-beta-0004 79 12/22/2024
2.2.0-beta-0001 90 10/28/2024
2.1.1 118 10/28/2024
2.1.0 126 10/19/2024
2.1.0-beta-0016 92 10/19/2024
2.1.0-beta-0015 84 10/19/2024
2.1.0-beta-0014 94 10/19/2024
2.1.0-beta-0013 102 10/19/2024
2.1.0-beta-0011 108 10/18/2024
2.1.0-beta-0010 113 10/18/2024
2.1.0-beta-0004 86 10/8/2024
2.1.0-beta-0002 77 10/6/2024
2.0.2 111 10/6/2024
2.0.1 107 10/6/2024
2.0.0 101 10/4/2024
2.0.0-beta-0060 82 10/6/2024
2.0.0-beta-0059 78 10/6/2024
2.0.0-beta-0056 83 10/4/2024
2.0.0-beta-0054 92 10/3/2024
2.0.0-beta-0053 81 10/2/2024
2.0.0-beta-0052 86 10/2/2024
2.0.0-beta-0050 86 10/2/2024
2.0.0-beta-0049 81 10/2/2024
2.0.0-beta-0046 78 10/1/2024
2.0.0-beta-0044 84 9/30/2024
2.0.0-beta-0026 88 9/24/2024
2.0.0-beta-0023 84 9/23/2024
2.0.0-beta-0022 77 9/23/2024
2.0.0-beta-0020 86 9/22/2024
2.0.0-beta-0004 82 9/20/2024
2.0.0-beta-0003 86 9/20/2024
1.9.0-beta-0003 95 9/16/2024
1.9.0-beta-0001 93 9/15/2024
1.9.0-beta 92 9/15/2024
1.8.1 114 9/14/2024
1.8.1-beta-0006 91 9/14/2024
1.8.1-beta-0005 101 9/14/2024
1.8.1-beta-0004 88 9/14/2024
1.8.1-beta-0003 90 9/14/2024
1.8.1-beta-0002 96 9/14/2024
1.8.1-beta-0001 92 9/14/2024
1.8.0 130 9/12/2024
1.8.0-beta-0064 98 9/12/2024
1.8.0-beta-0063 93 9/12/2024
1.8.0-beta-0059 80 9/8/2024
1.8.0-beta-0058 77 9/8/2024
1.8.0-beta-0057 88 9/8/2024
1.8.0-beta-0054 92 9/7/2024
1.8.0-beta-0053 101 9/6/2024
1.8.0-beta-0052 80 9/6/2024
1.8.0-beta-0051 97 9/6/2024
1.8.0-beta-0044 109 9/5/2024
1.8.0-beta-0042 92 9/4/2024
1.8.0-beta-0041 98 9/4/2024
1.8.0-beta-0027 113 8/25/2024
1.8.0-beta-0022 134 8/23/2024
1.8.0-beta-0017 122 8/7/2024
1.8.0-beta-0012 87 7/28/2024
1.8.0-beta-0010 94 7/28/2024
1.7.5 157 8/23/2024
1.7.4 143 8/9/2024
1.7.3 120 8/7/2024
1.7.2 129 7/28/2024
1.7.1 97 7/28/2024
1.7.0 103 7/20/2024
1.7.0-beta-0005 79 7/20/2024
1.7.0-beta-0001 90 7/8/2024
1.6.0 99 7/8/2024
1.6.0-beta-0004 91 7/7/2024
1.5.0 124 7/6/2024
1.5.0-beta-0010 96 7/6/2024