Shiny.Mediator 4.4.0-beta-0004

Prefix Reserved
This is a prerelease version of Shiny.Mediator.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator --version 4.4.0-beta-0004
                    
NuGet\Install-Package Shiny.Mediator -Version 4.4.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.4.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.4.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.4.0-beta-0004
                    
#r "nuget: Shiny.Mediator, 4.4.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.
#addin nuget:?package=Shiny.Mediator&version=4.4.0-beta-0004&prerelease
                    
Install Shiny.Mediator as a Cake Addin
#tool nuget:?package=Shiny.Mediator&version=4.4.0-beta-0004&prerelease
                    
Install Shiny.Mediator 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.4.0-beta-0023 109 5/29/2025
4.4.0-beta-0021 112 5/29/2025
4.4.0-beta-0018 174 5/26/2025
4.4.0-beta-0017 175 5/26/2025
4.4.0-beta-0015 169 5/26/2025
4.4.0-beta-0014 178 5/26/2025
4.4.0-beta-0004 128 5/25/2025
4.2.2 220 5/24/2025
4.2.1 313 5/8/2025
4.2.0 305 4/25/2025
4.2.0-beta-0010 187 5/8/2025
4.2.0-beta-0009 185 5/8/2025
4.2.0-beta-0008 147 4/25/2025
4.2.0-beta-0001 238 4/16/2025
4.1.0 488 3/28/2025
4.1.0-beta-0001 170 3/28/2025
4.0.4 476 3/24/2025
4.0.4-beta-0001 443 3/24/2025
4.0.3 310 3/23/2025
4.0.3-beta-0007 304 3/23/2025
4.0.2 276 3/15/2025
4.0.1 421 3/5/2025
4.0.1-beta-0010 192 3/19/2025
4.0.1-beta-0009 113 3/15/2025
4.0.1-beta-0001 262 3/5/2025
4.0.0 266 3/4/2025
4.0.0-beta-0021 252 3/4/2025
4.0.0-beta-0017 249 3/4/2025
4.0.0-beta-0016 250 3/4/2025
4.0.0-beta-0010 140 3/2/2025
4.0.0-beta-0009 138 3/2/2025
4.0.0-beta-0002 143 3/1/2025
3.3.1 314 2/20/2025
3.3.0 153 2/20/2025
3.3.0-beta-0028 134 2/20/2025
3.3.0-beta-0025 161 2/19/2025
3.3.0-beta-0024 174 2/19/2025
3.3.0-beta-0004 128 2/8/2025
3.2.0 414 1/29/2025
3.2.0-beta-0027 123 1/29/2025
3.2.0-beta-0023 129 1/29/2025
3.2.0-beta-0020 126 1/29/2025
3.1.3 133 1/29/2025
3.1.2 138 1/28/2025
3.1.1 158 1/25/2025
3.1.0 132 1/25/2025
3.1.0-beta-0013 126 1/25/2025
3.1.0-beta-0006 120 1/25/2025
3.1.0-beta-0004 123 1/25/2025
3.0.0 126 1/24/2025
3.0.0-beta-0055 123 1/24/2025
3.0.0-beta-0046 119 1/23/2025
3.0.0-beta-0045 129 1/23/2025
3.0.0-beta-0043 141 1/23/2025
3.0.0-beta-0038 143 1/21/2025
3.0.0-beta-0037 122 1/21/2025
3.0.0-beta-0029 130 1/21/2025
3.0.0-beta-0028 131 1/21/2025
3.0.0-beta-0018 123 1/19/2025
3.0.0-beta-0016 95 1/14/2025
3.0.0-beta-0012 111 1/12/2025
3.0.0-beta-0008 142 1/2/2025
3.0.0-beta-0007 133 12/28/2024
3.0.0-beta-0004 127 12/22/2024
2.2.0-beta-0001 334 10/28/2024
2.1.1 722 10/28/2024
2.1.0 292 10/19/2024
2.1.0-beta-0016 139 10/19/2024
2.1.0-beta-0015 136 10/19/2024
2.1.0-beta-0014 153 10/19/2024
2.1.0-beta-0013 151 10/19/2024
2.1.0-beta-0011 165 10/18/2024
2.1.0-beta-0010 155 10/18/2024
2.1.0-beta-0004 134 10/8/2024
2.1.0-beta-0002 131 10/6/2024
2.0.2 413 10/6/2024
2.0.1 160 10/6/2024
2.0.0 232 10/4/2024
2.0.0-beta-0060 130 10/6/2024
2.0.0-beta-0059 125 10/6/2024
2.0.0-beta-0056 132 10/4/2024
2.0.0-beta-0054 138 10/3/2024
2.0.0-beta-0053 138 10/2/2024
2.0.0-beta-0052 140 10/2/2024
2.0.0-beta-0050 136 10/2/2024
2.0.0-beta-0049 141 10/2/2024
2.0.0-beta-0046 143 10/1/2024
2.0.0-beta-0044 137 9/30/2024
2.0.0-beta-0026 144 9/24/2024
2.0.0-beta-0023 132 9/23/2024
2.0.0-beta-0022 121 9/23/2024
2.0.0-beta-0020 128 9/22/2024
2.0.0-beta-0004 131 9/20/2024
2.0.0-beta-0003 141 9/20/2024
1.9.0-beta-0003 144 9/16/2024
1.9.0-beta-0001 146 9/15/2024
1.9.0-beta 144 9/15/2024
1.8.1 342 9/14/2024
1.8.1-beta-0006 138 9/14/2024
1.8.1-beta-0005 147 9/14/2024
1.8.1-beta-0004 142 9/14/2024
1.8.1-beta-0003 143 9/14/2024
1.8.1-beta-0002 141 9/14/2024
1.8.1-beta-0001 146 9/14/2024
1.8.0 206 9/12/2024
1.8.0-beta-0064 145 9/12/2024
1.8.0-beta-0063 165 9/12/2024
1.8.0-beta-0059 157 9/8/2024
1.8.0-beta-0058 144 9/8/2024
1.8.0-beta-0057 159 9/8/2024
1.8.0-beta-0054 172 9/7/2024
1.8.0-beta-0053 168 9/6/2024
1.8.0-beta-0052 157 9/6/2024
1.8.0-beta-0051 163 9/6/2024
1.8.0-beta-0044 168 9/5/2024
1.8.0-beta-0042 159 9/4/2024
1.8.0-beta-0041 153 9/4/2024
1.8.0-beta-0027 174 8/25/2024
1.8.0-beta-0022 173 8/23/2024
1.8.0-beta-0017 159 8/7/2024
1.8.0-beta-0012 109 7/28/2024
1.8.0-beta-0010 97 7/28/2024
1.7.5 222 8/23/2024
1.7.4 326 8/9/2024
1.7.3 177 8/7/2024
1.7.2 144 7/28/2024
1.7.1 119 7/28/2024
1.7.0 186 7/20/2024
1.7.0-beta-0005 126 7/20/2024
1.7.0-beta-0001 137 7/8/2024
1.6.0 183 7/8/2024
1.6.0-beta-0004 134 7/7/2024
1.5.0 167 7/6/2024
1.5.0-beta-0010 139 7/6/2024
1.5.0-beta-0006 132 7/4/2024
1.4.5 156 7/4/2024
1.4.2 165 6/30/2024
1.4.1 166 6/30/2024
1.4.0 165 6/30/2024
1.4.0-beta-0010 151 6/30/2024
1.3.1 167 6/29/2024
1.3.0 153 6/29/2024
1.3.0-beta-0014 137 6/29/2024
1.3.0-beta-0007 128 6/26/2024
1.2.0 158 6/20/2024
1.2.0-beta-0001 117 6/20/2024
1.1.0 154 6/17/2024
1.1.0-beta-0019 126 6/20/2024
1.1.0-beta-0016 129 6/19/2024
1.1.0-beta-0014 138 6/17/2024
1.1.0-beta-0013 138 6/17/2024
1.0.0 184 6/15/2024
1.0.0-alpha-0054 132 6/15/2024
1.0.0-alpha-0053 131 6/12/2024
1.0.0-alpha-0051 112 6/12/2024
1.0.0-alpha-0048 127 6/10/2024
1.0.0-alpha-0047 133 6/10/2024
1.0.0-alpha-0043 118 6/9/2024
1.0.0-alpha-0042 153 6/7/2024
1.0.0-alpha-0040 128 6/6/2024
1.0.0-alpha-0038 125 6/6/2024
1.0.0-alpha-0036 116 6/5/2024
1.0.0-alpha-0034 142 6/4/2024
1.0.0-alpha-0031 123 6/4/2024
1.0.0-alpha-0025 124 6/3/2024
1.0.0-alpha-0023 133 6/2/2024
1.0.0-alpha-0022 134 6/1/2024
1.0.0-alpha-0019 130 6/1/2024
1.0.0-alpha-0018 118 6/1/2024
1.0.0-alpha-0014 129 6/1/2024
1.0.0-alpha-0013 114 6/1/2024
1.0.0-alpha-0012 118 5/31/2024
1.0.0-alpha-0011 112 5/31/2024
1.0.0-alpha-0010 119 5/31/2024