Shiny.Mediator.Contracts 3.3.0-beta-0024

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

    • No dependencies.
  • net9.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Shiny.Mediator.Contracts:

Package Downloads
Shiny.Mediator

The main Shiny Mediator library where all the infrastructure lives

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.7.0 85 6/25/2025
4.7.0-beta-0023 110 6/25/2025
4.7.0-beta-0022 114 6/24/2025
4.7.0-beta-0021 135 6/23/2025
4.7.0-beta-0020 148 6/19/2025
4.7.0-beta-0004 139 6/19/2025
4.6.6 151 6/19/2025
4.6.5 146 6/19/2025
4.6.4 142 6/19/2025
4.6.3 223 6/18/2025
4.6.2 180 6/18/2025
4.6.1 204 6/16/2025
4.6.1-beta-0005 178 6/18/2025
4.6.1-beta-0003 185 6/18/2025
4.6.1-beta-0001 178 6/16/2025
4.6.0 180 6/16/2025
4.5.0 389 6/10/2025
4.5.0-beta-0007 322 6/10/2025
4.5.0-beta-0006 305 6/9/2025
4.5.0-beta-0004 137 6/6/2025
4.5.0-beta-0002 168 6/6/2025
4.4.0 326 6/3/2025
4.4.0-beta-0025 180 6/3/2025
4.4.0-beta-0023 184 5/29/2025
4.4.0-beta-0021 189 5/29/2025
4.4.0-beta-0018 186 5/26/2025
4.4.0-beta-0017 184 5/26/2025
4.4.0-beta-0015 185 5/26/2025
4.4.0-beta-0014 193 5/26/2025
4.4.0-beta-0004 146 5/25/2025
4.2.2 366 5/24/2025
4.2.1 331 5/8/2025
4.2.0 319 4/25/2025
4.2.0-beta-0010 199 5/8/2025
4.2.0-beta-0009 190 5/8/2025
4.2.0-beta-0008 158 4/25/2025
4.2.0-beta-0001 245 4/16/2025
4.1.0 505 3/28/2025
4.1.0-beta-0001 187 3/28/2025
4.0.4 491 3/24/2025
4.0.4-beta-0001 451 3/24/2025
4.0.3 319 3/23/2025
4.0.3-beta-0007 315 3/23/2025
4.0.2 291 3/15/2025
4.0.1 426 3/5/2025
4.0.1-beta-0010 204 3/19/2025
4.0.1-beta-0009 122 3/15/2025
4.0.1-beta-0001 275 3/5/2025
4.0.0 271 3/4/2025
4.0.0-beta-0021 259 3/4/2025
4.0.0-beta-0017 248 3/4/2025
4.0.0-beta-0016 268 3/4/2025
4.0.0-beta-0010 154 3/2/2025
4.0.0-beta-0009 157 3/2/2025
4.0.0-beta-0002 155 3/1/2025
3.3.1 329 2/20/2025
3.3.0 161 2/20/2025
3.3.0-beta-0028 141 2/20/2025
3.3.0-beta-0025 174 2/19/2025
3.3.0-beta-0024 177 2/19/2025
3.3.0-beta-0004 137 2/8/2025
3.2.0 424 1/29/2025
3.2.0-beta-0027 126 1/29/2025
3.2.0-beta-0023 136 1/29/2025
3.2.0-beta-0020 126 1/29/2025
3.1.3 145 1/29/2025
3.1.2 152 1/28/2025
3.1.1 170 1/25/2025
3.1.0 144 1/25/2025
3.1.0-beta-0013 128 1/25/2025
3.1.0-beta-0006 132 1/25/2025
3.1.0-beta-0004 136 1/25/2025
3.0.0 139 1/24/2025
3.0.0-beta-0055 132 1/24/2025
3.0.0-beta-0046 126 1/23/2025
3.0.0-beta-0045 135 1/23/2025
3.0.0-beta-0043 141 1/23/2025
3.0.0-beta-0038 157 1/21/2025
3.0.0-beta-0037 134 1/21/2025
3.0.0-beta-0029 145 1/21/2025
3.0.0-beta-0028 133 1/21/2025
3.0.0-beta-0018 134 1/19/2025
3.0.0-beta-0016 117 1/14/2025
3.0.0-beta-0012 129 1/12/2025
3.0.0-beta-0008 143 1/2/2025
3.0.0-beta-0007 147 12/28/2024
3.0.0-beta-0004 137 12/22/2024
2.2.0-beta-0001 343 10/28/2024
2.1.1 736 10/28/2024
2.1.0 291 10/19/2024
2.1.0-beta-0016 146 10/19/2024
2.1.0-beta-0015 153 10/19/2024
2.1.0-beta-0014 165 10/19/2024
2.1.0-beta-0013 161 10/19/2024
2.1.0-beta-0011 174 10/18/2024
2.1.0-beta-0010 163 10/18/2024
2.1.0-beta-0004 144 10/8/2024
2.1.0-beta-0002 139 10/6/2024
2.0.2 421 10/6/2024
2.0.1 159 10/6/2024
2.0.0 227 10/4/2024
2.0.0-beta-0060 144 10/6/2024
2.0.0-beta-0059 134 10/6/2024
2.0.0-beta-0056 143 10/4/2024
2.0.0-beta-0054 146 10/3/2024
2.0.0-beta-0053 134 10/2/2024
2.0.0-beta-0052 147 10/2/2024
2.0.0-beta-0050 150 10/2/2024
2.0.0-beta-0049 149 10/2/2024
2.0.0-beta-0046 155 10/1/2024
2.0.0-beta-0044 151 9/30/2024
2.0.0-beta-0026 155 9/24/2024
2.0.0-beta-0023 144 9/23/2024
2.0.0-beta-0022 135 9/23/2024
2.0.0-beta-0020 164 9/22/2024
2.0.0-beta-0004 150 9/20/2024
2.0.0-beta-0003 160 9/20/2024
1.9.0-beta-0003 148 9/16/2024
1.9.0-beta-0001 154 9/15/2024
1.9.0-beta 148 9/15/2024
1.8.1 331 9/14/2024
1.8.1-beta-0006 146 9/14/2024
1.8.1-beta-0005 147 9/14/2024
1.8.1-beta-0004 162 9/14/2024
1.8.1-beta-0003 149 9/14/2024
1.8.1-beta-0002 164 9/14/2024
1.8.1-beta-0001 152 9/14/2024
1.8.0 226 9/12/2024
1.8.0-beta-0064 177 9/12/2024
1.8.0-beta-0063 180 9/12/2024
1.8.0-beta-0059 172 9/8/2024
1.8.0-beta-0058 152 9/8/2024
1.8.0-beta-0057 185 9/8/2024
1.8.0-beta-0054 177 9/7/2024
1.8.0-beta-0053 185 9/6/2024
1.8.0-beta-0052 168 9/6/2024
1.8.0-beta-0051 187 9/6/2024
1.8.0-beta-0044 178 9/5/2024
1.8.0-beta-0042 170 9/4/2024
1.8.0-beta-0041 171 9/4/2024
1.8.0-beta-0027 179 8/25/2024
1.8.0-beta-0022 179 8/23/2024
1.8.0-beta-0017 174 8/7/2024
1.8.0-beta-0012 118 7/28/2024
1.8.0-beta-0010 122 7/28/2024
1.7.5 226 8/23/2024
1.7.4 336 8/9/2024
1.7.3 183 8/7/2024
1.7.2 156 7/28/2024
1.7.1 134 7/28/2024
1.7.0 204 7/20/2024
1.7.0-beta-0005 148 7/20/2024
1.7.0-beta-0001 177 7/8/2024
1.6.0 190 7/8/2024
1.6.0-beta-0004 156 7/7/2024
1.5.0 188 7/6/2024
1.5.0-beta-0010 156 7/6/2024
1.5.0-beta-0006 159 7/4/2024
1.4.5 186 7/4/2024
1.4.2 185 6/30/2024
1.4.1 172 6/30/2024
1.4.0 168 6/30/2024
1.4.0-beta-0010 151 6/30/2024
1.3.1 176 6/29/2024
1.3.0 163 6/29/2024
1.3.0-beta-0014 140 6/29/2024
1.3.0-beta-0007 133 6/26/2024
1.2.0 172 6/20/2024
1.2.0-beta-0001 144 6/20/2024
1.1.0 175 6/17/2024
1.1.0-beta-0019 149 6/20/2024
1.1.0-beta-0016 150 6/19/2024
1.1.0-beta-0014 147 6/17/2024
1.1.0-beta-0013 137 6/17/2024
1.0.0 194 6/15/2024
1.0.0-alpha-0054 146 6/15/2024
1.0.0-alpha-0053 148 6/12/2024
1.0.0-alpha-0051 125 6/12/2024
1.0.0-alpha-0048 131 6/10/2024
1.0.0-alpha-0047 131 6/10/2024
1.0.0-alpha-0043 134 6/9/2024
1.0.0-alpha-0042 152 6/7/2024
1.0.0-alpha-0040 132 6/6/2024
1.0.0-alpha-0038 137 6/6/2024
1.0.0-alpha-0036 138 6/5/2024
1.0.0-alpha-0034 152 6/4/2024
1.0.0-alpha-0031 133 6/4/2024
1.0.0-alpha-0025 137 6/3/2024
1.0.0-alpha-0023 135 6/2/2024
1.0.0-alpha-0022 143 6/1/2024
1.0.0-alpha-0019 129 6/1/2024
1.0.0-alpha-0018 137 6/1/2024
1.0.0-alpha-0014 142 6/1/2024
1.0.0-alpha-0013 139 6/1/2024
1.0.0-alpha-0012 153 5/31/2024
1.0.0-alpha-0011 151 5/31/2024
1.0.0-alpha-0010 154 5/31/2024