Shiny.Mediator 3.2.0-beta-0027

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 3.2.0-beta-0027                
NuGet\Install-Package Shiny.Mediator -Version 3.2.0-beta-0027                
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="3.2.0-beta-0027" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shiny.Mediator --version 3.2.0-beta-0027                
#r "nuget: Shiny.Mediator, 3.2.0-beta-0027"                
#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.
// Install Shiny.Mediator as a Cake Addin
#addin nuget:?package=Shiny.Mediator&version=3.2.0-beta-0027&prerelease

// Install Shiny.Mediator as a Cake Tool
#tool nuget:?package=Shiny.Mediator&version=3.2.0-beta-0027&prerelease                

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (10)

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
3.3.0-beta-0004 98 10 days ago
3.2.0 257 19 days ago
3.2.0-beta-0027 74 19 days ago
3.2.0-beta-0023 94 20 days ago
3.2.0-beta-0020 92 20 days ago
3.1.3 93 20 days ago
3.1.2 102 21 days ago
3.1.1 113 24 days ago
3.1.0 95 24 days ago
3.1.0-beta-0013 91 24 days ago
3.1.0-beta-0006 88 24 days ago
3.1.0-beta-0004 87 24 days ago
3.0.0 75 24 days ago
3.0.0-beta-0055 80 24 days ago
3.0.0-beta-0046 88 a month ago
3.0.0-beta-0045 96 a month ago
3.0.0-beta-0043 102 a month ago
3.0.0-beta-0038 115 a month ago
3.0.0-beta-0037 101 a month ago
3.0.0-beta-0029 108 a month ago
3.0.0-beta-0028 106 a month ago
3.0.0-beta-0018 103 a month ago
3.0.0-beta-0016 66 a month ago
3.0.0-beta-0012 87 a month ago
3.0.0-beta-0008 120 2 months ago
3.0.0-beta-0007 124 2 months ago
3.0.0-beta-0004 118 2 months ago
2.2.0-beta-0001 251 4 months ago
2.1.1 556 4 months ago
2.1.0 284 4 months ago
2.1.0-beta-0016 135 4 months ago
2.1.0-beta-0015 132 4 months ago
2.1.0-beta-0014 149 4 months ago
2.1.0-beta-0013 145 4 months ago
2.1.0-beta-0011 161 4 months ago
2.1.0-beta-0010 150 4 months ago
2.1.0-beta-0004 130 4 months ago
2.1.0-beta-0002 125 4 months ago
2.0.2 406 4 months ago
2.0.1 152 4 months ago
2.0.0 210 4 months ago
2.0.0-beta-0060 123 4 months ago
2.0.0-beta-0059 120 4 months ago
2.0.0-beta-0056 124 4 months ago
2.0.0-beta-0054 132 5 months ago
2.0.0-beta-0053 129 5 months ago
2.0.0-beta-0052 134 5 months ago
2.0.0-beta-0050 131 5 months ago
2.0.0-beta-0049 136 5 months ago
2.0.0-beta-0046 138 5 months ago
2.0.0-beta-0044 126 5 months ago
2.0.0-beta-0026 139 5 months ago
2.0.0-beta-0023 127 5 months ago
2.0.0-beta-0022 116 5 months ago
2.0.0-beta-0020 123 5 months ago
2.0.0-beta-0004 126 5 months ago
2.0.0-beta-0003 136 5 months ago
1.9.0-beta-0003 138 5 months ago
1.9.0-beta-0001 141 5 months ago
1.9.0-beta 139 5 months ago
1.8.1 326 5 months ago
1.8.1-beta-0006 133 5 months ago
1.8.1-beta-0005 141 5 months ago
1.8.1-beta-0004 135 5 months ago
1.8.1-beta-0003 138 5 months ago
1.8.1-beta-0002 136 5 months ago
1.8.1-beta-0001 139 5 months ago
1.8.0 200 5 months ago
1.8.0-beta-0064 141 5 months ago
1.8.0-beta-0063 162 5 months ago
1.8.0-beta-0059 146 5 months ago
1.8.0-beta-0058 140 5 months ago
1.8.0-beta-0057 149 5 months ago
1.8.0-beta-0054 169 5 months ago
1.8.0-beta-0053 165 5 months ago
1.8.0-beta-0052 154 5 months ago
1.8.0-beta-0051 160 5 months ago
1.8.0-beta-0044 165 5 months ago
1.8.0-beta-0042 156 5 months ago
1.8.0-beta-0041 150 5 months ago
1.8.0-beta-0027 171 6 months ago
1.8.0-beta-0022 167 6 months ago
1.8.0-beta-0017 152 6 months ago
1.8.0-beta-0012 105 7 months ago
1.8.0-beta-0010 93 7 months ago
1.7.5 217 6 months ago
1.7.4 320 6 months ago
1.7.3 172 6 months ago
1.7.2 139 7 months ago
1.7.1 113 7 months ago
1.7.0 177 7 months ago
1.7.0-beta-0005 122 7 months ago
1.7.0-beta-0001 132 7 months ago
1.6.0 178 7 months ago
1.6.0-beta-0004 128 7 months ago
1.5.0 161 7 months ago
1.5.0-beta-0010 135 7 months ago
1.5.0-beta-0006 126 7 months ago
1.4.5 149 7 months ago
1.4.2 158 8 months ago
1.4.1 159 8 months ago
1.4.0 157 8 months ago
1.4.0-beta-0010 145 8 months ago
1.3.1 151 8 months ago
1.3.0 148 8 months ago
1.3.0-beta-0014 133 8 months ago
1.3.0-beta-0007 122 8 months ago
1.2.0 153 8 months ago
1.2.0-beta-0001 113 8 months ago
1.1.0 139 8 months ago
1.1.0-beta-0019 123 8 months ago
1.1.0-beta-0016 125 8 months ago
1.1.0-beta-0014 134 8 months ago
1.1.0-beta-0013 136 8 months ago
1.0.0 163 8 months ago
1.0.0-alpha-0054 130 8 months ago
1.0.0-alpha-0053 128 8 months ago
1.0.0-alpha-0051 110 8 months ago
1.0.0-alpha-0048 121 8 months ago
1.0.0-alpha-0047 130 8 months ago
1.0.0-alpha-0043 116 8 months ago
1.0.0-alpha-0042 143 8 months ago
1.0.0-alpha-0040 126 8 months ago
1.0.0-alpha-0038 123 8 months ago
1.0.0-alpha-0036 113 8 months ago
1.0.0-alpha-0034 139 8 months ago
1.0.0-alpha-0031 121 8 months ago
1.0.0-alpha-0025 121 8 months ago
1.0.0-alpha-0023 130 9 months ago
1.0.0-alpha-0022 132 9 months ago
1.0.0-alpha-0019 128 9 months ago
1.0.0-alpha-0018 113 9 months ago
1.0.0-alpha-0014 126 9 months ago
1.0.0-alpha-0013 112 9 months ago
1.0.0-alpha-0012 114 9 months ago
1.0.0-alpha-0011 109 9 months ago
1.0.0-alpha-0010 116 9 months ago