Shiny.Mediator 4.9.0-beta-0003

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.9.0-beta-0003
                    
NuGet\Install-Package Shiny.Mediator -Version 4.9.0-beta-0003
                    
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.9.0-beta-0003" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shiny.Mediator" Version="4.9.0-beta-0003" />
                    
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.9.0-beta-0003
                    
#r "nuget: Shiny.Mediator, 4.9.0-beta-0003"
                    
#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.9.0-beta-0003
                    
#: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.9.0-beta-0003&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator&version=4.9.0-beta-0003&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 (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.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.10.0-beta-0006 12 8/28/2025
4.10.0-beta-0005 60 8/22/2025
4.10.0-beta-0004 91 8/22/2025
4.10.0-beta-0003 140 8/18/2025
4.10.0-beta-0002 137 8/18/2025
4.10.0-beta-0001 115 7/29/2025
4.9.1 285 7/29/2025
4.9.0 209 7/26/2025
4.9.0-beta-0005 489 7/22/2025
4.9.0-beta-0004 492 7/22/2025
4.9.0-beta-0003 489 7/22/2025
4.9.0-beta-0002 434 7/21/2025
4.9.0-beta-0001 361 7/21/2025
4.8.0 120 7/18/2025
4.8.0-beta-0004 42 7/18/2025
4.8.0-beta-0003 192 7/14/2025
4.8.0-beta-0002 179 7/14/2025
4.8.0-beta-0001 177 7/14/2025
4.7.0 432 6/25/2025
4.7.0-beta-0026 175 7/13/2025
4.7.0-beta-0025 179 7/10/2025
4.7.0-beta-0024 137 6/25/2025
4.7.0-beta-0023 184 6/25/2025
4.7.0-beta-0022 186 6/24/2025
4.7.0-beta-0021 188 6/23/2025
4.7.0-beta-0020 187 6/19/2025
4.7.0-beta-0004 186 6/19/2025
4.6.6 195 6/19/2025
4.6.5 190 6/19/2025
4.6.4 187 6/19/2025
4.6.3 437 6/18/2025
4.6.2 200 6/18/2025
4.6.1 223 6/16/2025
4.6.1-beta-0005 190 6/18/2025
4.6.1-beta-0003 190 6/18/2025
4.6.1-beta-0001 186 6/16/2025
4.6.0 195 6/16/2025
4.5.0 402 6/10/2025
4.5.0-beta-0007 335 6/10/2025
4.5.0-beta-0006 308 6/9/2025
4.5.0-beta-0004 145 6/6/2025
4.5.0-beta-0002 179 6/6/2025
4.4.0 432 6/3/2025
4.4.0-beta-0025 183 6/3/2025
4.4.0-beta-0023 189 5/29/2025
4.4.0-beta-0021 188 5/29/2025
4.4.0-beta-0018 196 5/26/2025
4.4.0-beta-0017 197 5/26/2025
4.4.0-beta-0015 186 5/26/2025
4.4.0-beta-0014 194 5/26/2025
4.4.0-beta-0004 151 5/25/2025
4.2.2 474 5/24/2025
4.2.1 362 5/8/2025
4.2.0 331 4/25/2025
4.2.0-beta-0010 206 5/8/2025
4.2.0-beta-0009 202 5/8/2025
4.2.0-beta-0008 167 4/25/2025
4.2.0-beta-0001 260 4/16/2025
4.1.0 514 3/28/2025
4.1.0-beta-0001 187 3/28/2025
4.0.4 496 3/24/2025
4.0.4-beta-0001 464 3/24/2025
4.0.3 323 3/23/2025
4.0.3-beta-0007 315 3/23/2025
4.0.2 295 3/15/2025
4.0.1 436 3/5/2025
4.0.1-beta-0010 209 3/19/2025
4.0.1-beta-0009 131 3/15/2025
4.0.1-beta-0001 285 3/5/2025
4.0.0 284 3/4/2025
4.0.0-beta-0021 271 3/4/2025
4.0.0-beta-0017 268 3/4/2025
4.0.0-beta-0016 275 3/4/2025
4.0.0-beta-0010 153 3/2/2025
4.0.0-beta-0009 150 3/2/2025
4.0.0-beta-0002 164 3/1/2025
3.3.1 338 2/20/2025
3.3.0 165 2/20/2025
3.3.0-beta-0028 152 2/20/2025
3.3.0-beta-0025 175 2/19/2025
3.3.0-beta-0024 199 2/19/2025
3.3.0-beta-0004 148 2/8/2025
3.2.0 433 1/29/2025
3.2.0-beta-0027 140 1/29/2025
3.2.0-beta-0023 149 1/29/2025
3.2.0-beta-0020 146 1/29/2025
3.1.3 149 1/29/2025
3.1.2 161 1/28/2025
3.1.1 176 1/25/2025
3.1.0 151 1/25/2025
3.1.0-beta-0013 143 1/25/2025
3.1.0-beta-0006 135 1/25/2025
3.1.0-beta-0004 136 1/25/2025
3.0.0 144 1/24/2025
3.0.0-beta-0055 143 1/24/2025
3.0.0-beta-0046 140 1/23/2025
3.0.0-beta-0045 140 1/23/2025
3.0.0-beta-0043 158 1/23/2025
3.0.0-beta-0038 161 1/21/2025
3.0.0-beta-0037 142 1/21/2025
3.0.0-beta-0029 143 1/21/2025
3.0.0-beta-0028 147 1/21/2025
3.0.0-beta-0018 136 1/19/2025
3.0.0-beta-0016 115 1/14/2025
3.0.0-beta-0012 132 1/12/2025
3.0.0-beta-0008 159 1/2/2025
3.0.0-beta-0007 148 12/28/2024
3.0.0-beta-0004 136 12/22/2024
2.2.0-beta-0001 354 10/28/2024
2.1.1 775 10/28/2024
2.1.0 304 10/19/2024
2.1.0-beta-0016 151 10/19/2024
2.1.0-beta-0015 152 10/19/2024
2.1.0-beta-0014 171 10/19/2024
2.1.0-beta-0013 168 10/19/2024
2.1.0-beta-0011 175 10/18/2024
2.1.0-beta-0010 170 10/18/2024
2.1.0-beta-0004 157 10/8/2024
2.1.0-beta-0002 150 10/6/2024
2.0.2 427 10/6/2024
2.0.1 172 10/6/2024
2.0.0 258 10/4/2024
2.0.0-beta-0060 149 10/6/2024
2.0.0-beta-0059 142 10/6/2024
2.0.0-beta-0056 148 10/4/2024
2.0.0-beta-0054 149 10/3/2024
2.0.0-beta-0053 152 10/2/2024
2.0.0-beta-0052 156 10/2/2024
2.0.0-beta-0050 156 10/2/2024
2.0.0-beta-0049 157 10/2/2024
2.0.0-beta-0046 166 10/1/2024
2.0.0-beta-0044 157 9/30/2024
2.0.0-beta-0026 162 9/24/2024
2.0.0-beta-0023 151 9/23/2024
2.0.0-beta-0022 135 9/23/2024
2.0.0-beta-0020 140 9/22/2024
2.0.0-beta-0004 144 9/20/2024
2.0.0-beta-0003 158 9/20/2024
1.9.0-beta-0003 162 9/16/2024
1.9.0-beta-0001 161 9/15/2024
1.9.0-beta 164 9/15/2024
1.8.1 354 9/14/2024
1.8.1-beta-0006 158 9/14/2024
1.8.1-beta-0005 161 9/14/2024
1.8.1-beta-0004 158 9/14/2024
1.8.1-beta-0003 154 9/14/2024
1.8.1-beta-0002 157 9/14/2024
1.8.1-beta-0001 161 9/14/2024
1.8.0 224 9/12/2024
1.8.0-beta-0064 162 9/12/2024
1.8.0-beta-0063 176 9/12/2024
1.8.0-beta-0059 174 9/8/2024
1.8.0-beta-0058 158 9/8/2024
1.8.0-beta-0057 174 9/8/2024
1.8.0-beta-0054 183 9/7/2024
1.8.0-beta-0053 181 9/6/2024
1.8.0-beta-0052 172 9/6/2024
1.8.0-beta-0051 173 9/6/2024
1.8.0-beta-0044 192 9/5/2024
1.8.0-beta-0042 177 9/4/2024
1.8.0-beta-0041 173 9/4/2024
1.8.0-beta-0027 191 8/25/2024
1.8.0-beta-0022 183 8/23/2024
1.8.0-beta-0017 172 8/7/2024
1.8.0-beta-0012 123 7/28/2024
1.8.0-beta-0010 111 7/28/2024
1.7.5 239 8/23/2024
1.7.4 342 8/9/2024
1.7.3 192 8/7/2024
1.7.2 163 7/28/2024
1.7.1 132 7/28/2024
1.7.0 202 7/20/2024
1.7.0-beta-0005 136 7/20/2024
1.7.0-beta-0001 156 7/8/2024
1.6.0 199 7/8/2024
1.6.0-beta-0004 147 7/7/2024
1.5.0 180 7/6/2024
1.5.0-beta-0010 157 7/6/2024
1.5.0-beta-0006 155 7/4/2024
1.4.5 169 7/4/2024
1.4.2 180 6/30/2024
1.4.1 183 6/30/2024
1.4.0 177 6/30/2024
1.4.0-beta-0010 166 6/30/2024
1.3.1 188 6/29/2024
1.3.0 171 6/29/2024
1.3.0-beta-0014 153 6/29/2024
1.3.0-beta-0007 141 6/26/2024
1.2.0 173 6/20/2024
1.2.0-beta-0001 136 6/20/2024
1.1.0 177 6/17/2024
1.1.0-beta-0019 141 6/20/2024
1.1.0-beta-0016 152 6/19/2024
1.1.0-beta-0014 148 6/17/2024
1.1.0-beta-0013 151 6/17/2024
1.0.0 209 6/15/2024
1.0.0-alpha-0054 143 6/15/2024
1.0.0-alpha-0053 153 6/12/2024
1.0.0-alpha-0051 132 6/12/2024
1.0.0-alpha-0048 149 6/10/2024
1.0.0-alpha-0047 145 6/10/2024
1.0.0-alpha-0043 128 6/9/2024
1.0.0-alpha-0042 176 6/7/2024
1.0.0-alpha-0040 148 6/6/2024
1.0.0-alpha-0038 144 6/6/2024
1.0.0-alpha-0036 136 6/5/2024
1.0.0-alpha-0034 153 6/4/2024
1.0.0-alpha-0031 141 6/4/2024
1.0.0-alpha-0025 134 6/3/2024
1.0.0-alpha-0023 151 6/2/2024
1.0.0-alpha-0022 148 6/1/2024
1.0.0-alpha-0019 146 6/1/2024
1.0.0-alpha-0018 137 6/1/2024
1.0.0-alpha-0014 140 6/1/2024
1.0.0-alpha-0013 133 6/1/2024
1.0.0-alpha-0012 139 5/31/2024
1.0.0-alpha-0011 128 5/31/2024
1.0.0-alpha-0010 131 5/31/2024