Shiny.Mediator.AppSupport 4.4.0

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

Showing the top 3 NuGet packages that depend on Shiny.Mediator.AppSupport:

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

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.5.0-beta-0004 29 6/6/2025
4.5.0-beta-0002 63 6/6/2025
4.4.0 109 6/3/2025
4.4.0-beta-0025 103 6/3/2025
4.4.0-beta-0023 138 5/29/2025
4.4.0-beta-0021 139 5/29/2025
4.4.0-beta-0018 144 5/26/2025
4.4.0-beta-0017 138 5/26/2025
4.4.0-beta-0015 138 5/26/2025
4.4.0-beta-0014 144 5/26/2025
4.4.0-beta-0004 90 5/25/2025
4.2.2 149 5/24/2025
4.2.1 214 5/8/2025
4.2.0 233 4/25/2025
4.2.0-beta-0010 146 5/8/2025
4.2.0-beta-0009 139 5/8/2025
4.2.0-beta-0008 102 4/25/2025
4.2.0-beta-0001 192 4/16/2025
4.1.0 217 3/28/2025
4.1.0-beta-0001 132 3/28/2025
4.0.4 420 3/24/2025
4.0.4-beta-0001 399 3/24/2025
4.0.3 272 3/23/2025
4.0.3-beta-0007 267 3/23/2025
4.0.2 153 3/15/2025
4.0.1 247 3/5/2025
4.0.1-beta-0010 150 3/19/2025
4.0.1-beta-0009 69 3/15/2025
4.0.1-beta-0001 219 3/5/2025
4.0.0 227 3/4/2025
4.0.0-beta-0021 214 3/4/2025
4.0.0-beta-0017 204 3/4/2025
4.0.0-beta-0016 215 3/4/2025
4.0.0-beta-0010 99 3/2/2025
4.0.0-beta-0009 101 3/2/2025
4.0.0-beta-0002 99 3/1/2025
3.3.1 215 2/20/2025
3.3.0 111 2/20/2025
3.3.0-beta-0028 95 2/20/2025
3.3.0-beta-0025 106 2/19/2025
3.3.0-beta-0024 102 2/19/2025
3.3.0-beta-0004 92 2/8/2025
3.2.0 202 1/29/2025
3.2.0-beta-0027 85 1/29/2025
3.2.0-beta-0023 84 1/29/2025
3.2.0-beta-0020 83 1/29/2025
3.1.3 116 1/29/2025
3.1.2 102 1/28/2025
3.1.1 104 1/25/2025
3.1.0 106 1/25/2025
3.1.0-beta-0013 85 1/25/2025
3.1.0-beta-0006 93 1/25/2025
3.1.0-beta-0004 93 1/25/2025
3.0.0 96 1/24/2025
3.0.0-beta-0055 86 1/24/2025
3.0.0-beta-0046 94 1/23/2025
3.0.0-beta-0045 86 1/23/2025
3.0.0-beta-0043 97 1/23/2025
3.0.0-beta-0038 100 1/21/2025
3.0.0-beta-0037 88 1/21/2025
3.0.0-beta-0029 88 1/21/2025
3.0.0-beta-0028 92 1/21/2025
3.0.0-beta-0018 93 1/19/2025
3.0.0-beta-0016 66 1/14/2025
3.0.0-beta-0012 82 1/12/2025
3.0.0-beta-0008 92 1/2/2025
3.0.0-beta-0007 97 12/28/2024
3.0.0-beta-0004 100 12/22/2024
2.2.0-beta-0001 302 10/28/2024
2.1.1 494 10/28/2024
2.1.0 251 10/19/2024
2.1.0-beta-0016 100 10/19/2024
2.1.0-beta-0015 102 10/19/2024
2.1.0-beta-0014 117 10/19/2024
2.1.0-beta-0013 110 10/19/2024
2.1.0-beta-0011 126 10/18/2024
2.1.0-beta-0010 119 10/18/2024
2.1.0-beta-0004 97 10/8/2024
2.1.0-beta-0002 92 10/6/2024
2.0.2 146 10/6/2024
2.0.1 112 10/6/2024
2.0.0 179 10/4/2024
2.0.0-beta-0060 99 10/6/2024
2.0.0-beta-0059 95 10/6/2024
2.0.0-beta-0056 92 10/4/2024
2.0.0-beta-0054 108 10/3/2024
2.0.0-beta-0053 95 10/2/2024
2.0.0-beta-0052 100 10/2/2024
2.0.0-beta-0050 99 10/2/2024
2.0.0-beta-0049 100 10/2/2024
2.0.0-beta-0046 98 10/1/2024
2.0.0-beta-0044 114 9/30/2024
2.0.0-beta-0026 112 9/24/2024
2.0.0-beta-0023 105 9/23/2024
2.0.0-beta-0022 91 9/23/2024
2.0.0-beta-0020 105 9/22/2024
2.0.0-beta-0004 100 9/20/2024
2.0.0-beta-0003 101 9/20/2024