Shiny.Mediator.Contracts 3.3.0-beta-0025

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-0025
                    
NuGet\Install-Package Shiny.Mediator.Contracts -Version 3.3.0-beta-0025
                    
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-0025" />
                    
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-0025" />
                    
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-0025
                    
#r "nuget: Shiny.Mediator.Contracts, 3.3.0-beta-0025"
                    
#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.Contracts@3.3.0-beta-0025
                    
#: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.Contracts&version=3.3.0-beta-0025&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shiny.Mediator.Contracts&version=3.3.0-beta-0025&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.10.0-beta-0020 193 9/19/2025
4.10.0-beta-0019 269 9/18/2025
4.10.0-beta-0018 262 9/18/2025
4.10.0-beta-0017 263 9/18/2025
4.10.0-beta-0016 263 9/18/2025
4.10.0-beta-0015 261 9/18/2025
4.10.0-beta-0014 263 9/18/2025
4.10.0-beta-0013 260 9/18/2025
4.10.0-beta-0012 292 9/18/2025
4.10.0-beta-0011 305 9/16/2025
4.10.0-beta-0010 312 9/16/2025
4.10.0-beta-0009 175 9/10/2025
4.10.0-beta-0008 159 9/10/2025
4.10.0-beta-0007 164 9/9/2025
4.10.0-beta-0006 239 8/28/2025
4.10.0-beta-0005 134 8/22/2025
4.10.0-beta-0004 156 8/22/2025
4.10.0-beta-0003 168 8/18/2025
4.10.0-beta-0002 160 8/18/2025
4.10.0-beta-0001 128 7/29/2025
4.9.1 611 7/29/2025
4.9.0 219 7/26/2025
4.9.0-beta-0005 573 7/22/2025
4.9.0-beta-0004 566 7/22/2025
4.9.0-beta-0003 559 7/22/2025
4.9.0-beta-0002 542 7/21/2025
4.9.0-beta-0001 468 7/21/2025
4.8.0 297 7/18/2025
4.8.0-beta-0004 147 7/18/2025
4.8.0-beta-0003 216 7/14/2025
4.8.0-beta-0002 204 7/14/2025
4.8.0-beta-0001 193 7/14/2025
4.7.0 476 6/25/2025
4.7.0-beta-0026 193 7/13/2025
4.7.0-beta-0025 193 7/10/2025
4.7.0-beta-0023 204 6/25/2025
4.7.0-beta-0022 197 6/24/2025
4.7.0-beta-0021 204 6/23/2025
4.7.0-beta-0020 204 6/19/2025
4.7.0-beta-0004 199 6/19/2025
4.6.6 211 6/19/2025
4.6.5 207 6/19/2025
4.6.4 199 6/19/2025
4.6.3 487 6/18/2025
4.6.2 204 6/18/2025
4.6.1 233 6/16/2025
4.6.1-beta-0005 199 6/18/2025
4.6.1-beta-0003 199 6/18/2025
4.6.1-beta-0001 195 6/16/2025
4.6.0 199 6/16/2025
4.5.0 406 6/10/2025
4.5.0-beta-0007 335 6/10/2025
4.5.0-beta-0006 322 6/9/2025
4.5.0-beta-0004 154 6/6/2025
4.5.0-beta-0002 185 6/6/2025
4.4.0 452 6/3/2025
4.4.0-beta-0025 196 6/3/2025
4.4.0-beta-0023 200 5/29/2025
4.4.0-beta-0021 209 5/29/2025
4.4.0-beta-0018 212 5/26/2025
4.4.0-beta-0017 202 5/26/2025
4.4.0-beta-0015 202 5/26/2025
4.4.0-beta-0014 210 5/26/2025
4.4.0-beta-0004 163 5/25/2025
4.2.2 406 5/24/2025
4.2.1 369 5/8/2025
4.2.0 335 4/25/2025
4.2.0-beta-0010 218 5/8/2025
4.2.0-beta-0009 206 5/8/2025
4.2.0-beta-0008 172 4/25/2025
4.2.0-beta-0001 265 4/16/2025
4.1.0 525 3/28/2025
4.1.0-beta-0001 205 3/28/2025
4.0.4 504 3/24/2025
4.0.4-beta-0001 467 3/24/2025
4.0.3 336 3/23/2025
4.0.3-beta-0007 331 3/23/2025
4.0.2 307 3/15/2025
4.0.1 438 3/5/2025
4.0.1-beta-0010 221 3/19/2025
4.0.1-beta-0009 136 3/15/2025
4.0.1-beta-0001 289 3/5/2025
4.0.0 289 3/4/2025
4.0.0-beta-0021 272 3/4/2025
4.0.0-beta-0017 264 3/4/2025
4.0.0-beta-0016 282 3/4/2025
4.0.0-beta-0010 173 3/2/2025
4.0.0-beta-0009 171 3/2/2025
4.0.0-beta-0002 174 3/1/2025
3.3.1 351 2/20/2025
3.3.0 180 2/20/2025
3.3.0-beta-0028 158 2/20/2025
3.3.0-beta-0025 192 2/19/2025
3.3.0-beta-0024 191 2/19/2025
3.3.0-beta-0004 155 2/8/2025
3.2.0 435 1/29/2025
3.2.0-beta-0027 139 1/29/2025
3.2.0-beta-0023 148 1/29/2025
3.2.0-beta-0020 143 1/29/2025
3.1.3 161 1/29/2025
3.1.2 162 1/28/2025
3.1.1 184 1/25/2025
3.1.0 157 1/25/2025
3.1.0-beta-0013 147 1/25/2025
3.1.0-beta-0006 147 1/25/2025
3.1.0-beta-0004 148 1/25/2025
3.0.0 152 1/24/2025
3.0.0-beta-0055 143 1/24/2025
3.0.0-beta-0046 142 1/23/2025
3.0.0-beta-0045 153 1/23/2025
3.0.0-beta-0043 156 1/23/2025
3.0.0-beta-0038 174 1/21/2025
3.0.0-beta-0037 147 1/21/2025
3.0.0-beta-0029 160 1/21/2025
3.0.0-beta-0028 148 1/21/2025
3.0.0-beta-0018 146 1/19/2025
3.0.0-beta-0016 127 1/14/2025
3.0.0-beta-0012 148 1/12/2025
3.0.0-beta-0008 159 1/2/2025
3.0.0-beta-0007 159 12/28/2024
3.0.0-beta-0004 153 12/22/2024
2.2.0-beta-0001 360 10/28/2024
2.1.1 770 10/28/2024
2.1.0 305 10/19/2024
2.1.0-beta-0016 162 10/19/2024
2.1.0-beta-0015 166 10/19/2024
2.1.0-beta-0014 175 10/19/2024
2.1.0-beta-0013 178 10/19/2024
2.1.0-beta-0011 191 10/18/2024
2.1.0-beta-0010 180 10/18/2024
2.1.0-beta-0004 160 10/8/2024
2.1.0-beta-0002 155 10/6/2024
2.0.2 436 10/6/2024
2.0.1 175 10/6/2024
2.0.0 243 10/4/2024
2.0.0-beta-0060 156 10/6/2024
2.0.0-beta-0059 147 10/6/2024
2.0.0-beta-0056 153 10/4/2024
2.0.0-beta-0054 165 10/3/2024
2.0.0-beta-0053 151 10/2/2024
2.0.0-beta-0052 161 10/2/2024
2.0.0-beta-0050 165 10/2/2024
2.0.0-beta-0049 158 10/2/2024
2.0.0-beta-0046 171 10/1/2024
2.0.0-beta-0044 165 9/30/2024
2.0.0-beta-0026 172 9/24/2024
2.0.0-beta-0023 156 9/23/2024
2.0.0-beta-0022 145 9/23/2024
2.0.0-beta-0020 181 9/22/2024
2.0.0-beta-0004 164 9/20/2024
2.0.0-beta-0003 175 9/20/2024
1.9.0-beta-0003 160 9/16/2024
1.9.0-beta-0001 171 9/15/2024
1.9.0-beta 164 9/15/2024
1.8.1 345 9/14/2024
1.8.1-beta-0006 157 9/14/2024
1.8.1-beta-0005 160 9/14/2024
1.8.1-beta-0004 179 9/14/2024
1.8.1-beta-0003 167 9/14/2024
1.8.1-beta-0002 173 9/14/2024
1.8.1-beta-0001 164 9/14/2024
1.8.0 238 9/12/2024
1.8.0-beta-0064 191 9/12/2024
1.8.0-beta-0063 192 9/12/2024
1.8.0-beta-0059 188 9/8/2024
1.8.0-beta-0058 169 9/8/2024
1.8.0-beta-0057 194 9/8/2024
1.8.0-beta-0054 191 9/7/2024
1.8.0-beta-0053 201 9/6/2024
1.8.0-beta-0052 184 9/6/2024
1.8.0-beta-0051 200 9/6/2024
1.8.0-beta-0044 190 9/5/2024
1.8.0-beta-0042 192 9/4/2024
1.8.0-beta-0041 182 9/4/2024
1.8.0-beta-0027 191 8/25/2024
1.8.0-beta-0022 189 8/23/2024
1.8.0-beta-0017 193 8/7/2024
1.8.0-beta-0012 134 7/28/2024
1.8.0-beta-0010 134 7/28/2024
1.7.5 239 8/23/2024
1.7.4 353 8/9/2024
1.7.3 201 8/7/2024
1.7.2 170 7/28/2024
1.7.1 151 7/28/2024
1.7.0 216 7/20/2024
1.7.0-beta-0005 164 7/20/2024
1.7.0-beta-0001 187 7/8/2024
1.6.0 203 7/8/2024
1.6.0-beta-0004 173 7/7/2024
1.5.0 205 7/6/2024
1.5.0-beta-0010 172 7/6/2024
1.5.0-beta-0006 175 7/4/2024
1.4.5 202 7/4/2024
1.4.2 203 6/30/2024
1.4.1 190 6/30/2024
1.4.0 185 6/30/2024
1.4.0-beta-0010 163 6/30/2024
1.3.1 189 6/29/2024
1.3.0 172 6/29/2024
1.3.0-beta-0014 156 6/29/2024
1.3.0-beta-0007 146 6/26/2024
1.2.0 190 6/20/2024
1.2.0-beta-0001 153 6/20/2024
1.1.0 196 6/17/2024
1.1.0-beta-0019 166 6/20/2024
1.1.0-beta-0016 167 6/19/2024
1.1.0-beta-0014 163 6/17/2024
1.1.0-beta-0013 155 6/17/2024
1.0.0 208 6/15/2024
1.0.0-alpha-0054 155 6/15/2024
1.0.0-alpha-0053 160 6/12/2024
1.0.0-alpha-0051 141 6/12/2024
1.0.0-alpha-0048 145 6/10/2024
1.0.0-alpha-0047 140 6/10/2024
1.0.0-alpha-0043 142 6/9/2024
1.0.0-alpha-0042 161 6/7/2024
1.0.0-alpha-0040 145 6/6/2024
1.0.0-alpha-0038 151 6/6/2024
1.0.0-alpha-0036 150 6/5/2024
1.0.0-alpha-0034 163 6/4/2024
1.0.0-alpha-0031 145 6/4/2024
1.0.0-alpha-0025 150 6/3/2024
1.0.0-alpha-0023 149 6/2/2024
1.0.0-alpha-0022 153 6/1/2024
1.0.0-alpha-0019 138 6/1/2024
1.0.0-alpha-0018 150 6/1/2024
1.0.0-alpha-0014 155 6/1/2024
1.0.0-alpha-0013 152 6/1/2024
1.0.0-alpha-0012 168 5/31/2024
1.0.0-alpha-0011 160 5/31/2024
1.0.0-alpha-0010 167 5/31/2024