Shiny.Mediator 4.5.0-beta-0004

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 4.5.0-beta-0004
                    
NuGet\Install-Package Shiny.Mediator -Version 4.5.0-beta-0004
                    
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="4.5.0-beta-0004" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shiny.Mediator" Version="4.5.0-beta-0004" />
                    
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 4.5.0-beta-0004
                    
#r "nuget: Shiny.Mediator, 4.5.0-beta-0004"
                    
#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@4.5.0-beta-0004
                    
#: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=4.5.0-beta-0004&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator&version=4.5.0-beta-0004&prerelease
                    
Install 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 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 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 (11)

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.AspNet

Shiny Mediator - A mediator pattern for all .NET Apps

GitHub repositories (1)

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

Repository Stars
shinyorg/templates
dotnet CLI & Visual Studio Templates
Version Downloads Last Updated
4.8.0 33 7/18/2025
4.8.0-beta-0004 37 7/18/2025
4.8.0-beta-0003 188 7/14/2025
4.8.0-beta-0002 175 7/14/2025
4.8.0-beta-0001 173 7/14/2025
4.7.0 410 6/25/2025
4.7.0-beta-0026 170 7/13/2025
4.7.0-beta-0025 174 7/10/2025
4.7.0-beta-0024 132 6/25/2025
4.7.0-beta-0023 179 6/25/2025
4.7.0-beta-0022 181 6/24/2025
4.7.0-beta-0021 181 6/23/2025
4.7.0-beta-0020 182 6/19/2025
4.7.0-beta-0004 181 6/19/2025
4.6.6 189 6/19/2025
4.6.5 184 6/19/2025
4.6.4 181 6/19/2025
4.6.3 414 6/18/2025
4.6.2 192 6/18/2025
4.6.1 216 6/16/2025
4.6.1-beta-0005 184 6/18/2025
4.6.1-beta-0003 185 6/18/2025
4.6.1-beta-0001 179 6/16/2025
4.6.0 188 6/16/2025
4.5.0 395 6/10/2025
4.5.0-beta-0007 330 6/10/2025
4.5.0-beta-0006 303 6/9/2025
4.5.0-beta-0004 140 6/6/2025
4.5.0-beta-0002 173 6/6/2025
4.4.0 424 6/3/2025
4.4.0-beta-0025 177 6/3/2025
4.4.0-beta-0023 184 5/29/2025
4.4.0-beta-0021 182 5/29/2025
4.4.0-beta-0018 190 5/26/2025
4.4.0-beta-0017 192 5/26/2025
4.4.0-beta-0015 182 5/26/2025
4.4.0-beta-0014 190 5/26/2025
4.4.0-beta-0004 145 5/25/2025
4.2.2 447 5/24/2025
4.2.1 354 5/8/2025
4.2.0 325 4/25/2025
4.2.0-beta-0010 202 5/8/2025
4.2.0-beta-0009 197 5/8/2025
4.2.0-beta-0008 161 4/25/2025
4.2.0-beta-0001 256 4/16/2025
4.1.0 508 3/28/2025
4.1.0-beta-0001 182 3/28/2025
4.0.4 490 3/24/2025
4.0.4-beta-0001 456 3/24/2025
4.0.3 319 3/23/2025
4.0.3-beta-0007 311 3/23/2025
4.0.2 288 3/15/2025
4.0.1 431 3/5/2025
4.0.1-beta-0010 204 3/19/2025
4.0.1-beta-0009 123 3/15/2025
4.0.1-beta-0001 278 3/5/2025
4.0.0 277 3/4/2025
4.0.0-beta-0021 265 3/4/2025
4.0.0-beta-0017 262 3/4/2025
4.0.0-beta-0016 267 3/4/2025
4.0.0-beta-0010 149 3/2/2025
4.0.0-beta-0009 146 3/2/2025
4.0.0-beta-0002 157 3/1/2025
3.3.1 332 2/20/2025
3.3.0 161 2/20/2025
3.3.0-beta-0028 147 2/20/2025
3.3.0-beta-0025 171 2/19/2025
3.3.0-beta-0024 193 2/19/2025
3.3.0-beta-0004 142 2/8/2025
3.2.0 428 1/29/2025
3.2.0-beta-0027 135 1/29/2025
3.2.0-beta-0023 142 1/29/2025
3.2.0-beta-0020 140 1/29/2025
3.1.3 145 1/29/2025
3.1.2 153 1/28/2025
3.1.1 168 1/25/2025
3.1.0 145 1/25/2025
3.1.0-beta-0013 139 1/25/2025
3.1.0-beta-0006 130 1/25/2025
3.1.0-beta-0004 130 1/25/2025
3.0.0 137 1/24/2025
3.0.0-beta-0055 139 1/24/2025
3.0.0-beta-0046 134 1/23/2025
3.0.0-beta-0045 135 1/23/2025
3.0.0-beta-0043 152 1/23/2025
3.0.0-beta-0038 156 1/21/2025
3.0.0-beta-0037 137 1/21/2025
3.0.0-beta-0029 138 1/21/2025
3.0.0-beta-0028 142 1/21/2025
3.0.0-beta-0018 129 1/19/2025
3.0.0-beta-0016 107 1/14/2025
3.0.0-beta-0012 128 1/12/2025
3.0.0-beta-0008 153 1/2/2025
3.0.0-beta-0007 143 12/28/2024
3.0.0-beta-0004 132 12/22/2024
2.2.0-beta-0001 349 10/28/2024
2.1.1 762 10/28/2024
2.1.0 299 10/19/2024
2.1.0-beta-0016 147 10/19/2024
2.1.0-beta-0015 146 10/19/2024
2.1.0-beta-0014 166 10/19/2024
2.1.0-beta-0013 162 10/19/2024
2.1.0-beta-0011 170 10/18/2024
2.1.0-beta-0010 166 10/18/2024
2.1.0-beta-0004 149 10/8/2024
2.1.0-beta-0002 145 10/6/2024
2.0.2 421 10/6/2024
2.0.1 167 10/6/2024
2.0.0 250 10/4/2024
2.0.0-beta-0060 143 10/6/2024
2.0.0-beta-0059 138 10/6/2024
2.0.0-beta-0056 144 10/4/2024
2.0.0-beta-0054 145 10/3/2024
2.0.0-beta-0053 147 10/2/2024
2.0.0-beta-0052 152 10/2/2024
2.0.0-beta-0050 150 10/2/2024
2.0.0-beta-0049 152 10/2/2024
2.0.0-beta-0046 160 10/1/2024
2.0.0-beta-0044 149 9/30/2024
2.0.0-beta-0026 156 9/24/2024
2.0.0-beta-0023 147 9/23/2024
2.0.0-beta-0022 130 9/23/2024
2.0.0-beta-0020 134 9/22/2024
2.0.0-beta-0004 140 9/20/2024
2.0.0-beta-0003 153 9/20/2024
1.9.0-beta-0003 158 9/16/2024
1.9.0-beta-0001 156 9/15/2024
1.9.0-beta 157 9/15/2024
1.8.1 350 9/14/2024
1.8.1-beta-0006 153 9/14/2024
1.8.1-beta-0005 157 9/14/2024
1.8.1-beta-0004 154 9/14/2024
1.8.1-beta-0003 149 9/14/2024
1.8.1-beta-0002 150 9/14/2024
1.8.1-beta-0001 156 9/14/2024
1.8.0 219 9/12/2024
1.8.0-beta-0064 157 9/12/2024
1.8.0-beta-0063 171 9/12/2024
1.8.0-beta-0059 170 9/8/2024
1.8.0-beta-0058 152 9/8/2024
1.8.0-beta-0057 170 9/8/2024
1.8.0-beta-0054 179 9/7/2024
1.8.0-beta-0053 177 9/6/2024
1.8.0-beta-0052 168 9/6/2024
1.8.0-beta-0051 168 9/6/2024
1.8.0-beta-0044 185 9/5/2024
1.8.0-beta-0042 170 9/4/2024
1.8.0-beta-0041 167 9/4/2024
1.8.0-beta-0027 186 8/25/2024
1.8.0-beta-0022 179 8/23/2024
1.8.0-beta-0017 167 8/7/2024
1.8.0-beta-0012 117 7/28/2024
1.8.0-beta-0010 106 7/28/2024
1.7.5 234 8/23/2024
1.7.4 336 8/9/2024
1.7.3 187 8/7/2024
1.7.2 158 7/28/2024
1.7.1 126 7/28/2024
1.7.0 198 7/20/2024
1.7.0-beta-0005 131 7/20/2024
1.7.0-beta-0001 151 7/8/2024
1.6.0 193 7/8/2024
1.6.0-beta-0004 140 7/7/2024
1.5.0 175 7/6/2024
1.5.0-beta-0010 153 7/6/2024
1.5.0-beta-0006 148 7/4/2024
1.4.5 164 7/4/2024
1.4.2 175 6/30/2024
1.4.1 177 6/30/2024
1.4.0 173 6/30/2024
1.4.0-beta-0010 161 6/30/2024
1.3.1 182 6/29/2024
1.3.0 164 6/29/2024
1.3.0-beta-0014 147 6/29/2024
1.3.0-beta-0007 136 6/26/2024
1.2.0 167 6/20/2024
1.2.0-beta-0001 131 6/20/2024
1.1.0 170 6/17/2024
1.1.0-beta-0019 134 6/20/2024
1.1.0-beta-0016 147 6/19/2024
1.1.0-beta-0014 144 6/17/2024
1.1.0-beta-0013 146 6/17/2024
1.0.0 200 6/15/2024
1.0.0-alpha-0054 139 6/15/2024
1.0.0-alpha-0053 146 6/12/2024
1.0.0-alpha-0051 127 6/12/2024
1.0.0-alpha-0048 143 6/10/2024
1.0.0-alpha-0047 140 6/10/2024
1.0.0-alpha-0043 123 6/9/2024
1.0.0-alpha-0042 171 6/7/2024
1.0.0-alpha-0040 142 6/6/2024
1.0.0-alpha-0038 140 6/6/2024
1.0.0-alpha-0036 129 6/5/2024
1.0.0-alpha-0034 149 6/4/2024
1.0.0-alpha-0031 133 6/4/2024
1.0.0-alpha-0025 130 6/3/2024
1.0.0-alpha-0023 146 6/2/2024
1.0.0-alpha-0022 142 6/1/2024
1.0.0-alpha-0019 141 6/1/2024
1.0.0-alpha-0018 131 6/1/2024
1.0.0-alpha-0014 136 6/1/2024
1.0.0-alpha-0013 126 6/1/2024
1.0.0-alpha-0012 135 5/31/2024
1.0.0-alpha-0011 123 5/31/2024
1.0.0-alpha-0010 126 5/31/2024