SingleFinite.Mvvm 0.0.26

SingleFinite.Mvvm

SingleFinite.Mvvm is a Model-View-ViewModel library. It's built for .NET Core and contains interfaces, classes, and services that provide a solid foundation for building a modern MVVM .NET application.

Getting started

The following example illustrates a simple "hello world" style app that shows how to get something up and running after adding the SingleFinite.Mvvm nuget package as a dependency in your project.

To start, let's define a simple view model class that extends ViewModel:

// MyViewModel.cs
//

using SingleFinite.Mvvm;

namespace  MyApp;

public class MyViewModel : ViewModel
{
}

and a corresponding view class that implements IView and will be used with the view model defined above:

// MyView.cs
//

using SingleFinite.Mvvm;

namespace MyApp;

public class MyView(MyViewModel viewModel) : IView<MyViewModel>
{
    public MyViewModel ViewModel => viewModel;
}

Now that we have a view model and view defined we can configure an instance of IAppHost that will host our application state:

// Program.cs
//

using SingleFinite.Mvvm;

namespace MyApp;

var appHost = new AppHostBuilder()
    .AddViews(views => views.Add<MyViewModel, MyView>())
    .BuildAndStart();

As you can see above we use the AddViews method to register the MyViewModel and MyView types. Now when we want to display an instance of MyViewModel an instance of MyView will be used to display it.

ℹ️ Note

There is an extension method for registering views that can be used to scan assemblies for ViewModel and IView types to register but we manually register them here for better clarity in the example.

Let's create a new instance of MyViewModel from the IAppHost instance we created above:

// Program.cs
//

// ...

var presentable = appHost.ServiceProvider.GetRequiredService<IPresentableItem>();
var viewModel = presentable.Set<MyViewModel>();

Console.WriteLine($"My ViewModel => {viewModel.GetType().FullName}");
Console.WriteLine($"My View => {presentable.Current.GetType().FullName}");

SingleFinite.MVVM is built on top of the Microsoft Dependency Injection library and the IAppHost object contains an IServiceProvider that holds all of the registered services. We get a new instance of IPresentableItem from the IServiceProvider which we use to create a new instance of our view model.

IPresentable services are used to create and manage the lifecycle of view models and their views. Both the view model and view will be created with a new dependency injection scope and will be injected with services as defined in their constructors. Normally you will use another platform specific library like SingleFinite.Mvvm.WinUI to manage the IAppHost instance and to present views for IPresentable based services.

Learn more

Check out the project Wiki for more detailed documentation on this library.