A platform-independent, lightweight library for developing .NET applications using the MVVM architecture
MIT License
This is a very lightweight library containing base classes for implementing .NET applications using the MVVM architecture. It is fully unit tested and platform independent.
Smaragd offers base implementations of key .NET interfaces for building WPF / MVVM applications.
In addition, it enables developers to:
DialogModel
and TreeViewModel
ViewModelCommand
and AsyncViewModelCommand
FuncValidation
and PredicateValidation
PropertySourceAttribute
For more information, please visit the documentation.
The recommended way to use this library is via NuGet.
Currently supported frameworks:
The following is a simple demonstration of some core features of Smaragd.
Choose a base class for your ViewModel.
ViewModel
if you want to use the fill feature set (recommended)Bindable
if you only want an implementation of INotifyPropertyChanged
and INotifyPropertyChanging
class AppViewModel : ViewModel
{
// ...
}
Add a property with a backing field that invokes PropertyChanged
when set.
class AppViewModel : ViewModel
{
private string _name;
public string Name
{
get => _name;
set => SetProperty(ref _name, value);
}
}
Make the property dependent on the ViewModel
's IsDirty
property. IsDirty
indicates whether property values have changed. The Name
property then automatically updates observing views when IsDirty
changes.
class AppViewModel : ViewModel
{
private string _name;
[PropertySource(nameof(IsDirty))]
public string Name
{
get => IsDirty ? $"{_name} (unsaved changes)" : _name;
set => SetProperty(ref _name, value);
}
}
Add an async command to reset the IsDirty
flag.
class AppViewModel : ViewModel
{
private string _name;
[PropertySource(nameof(IsDirty))]
public string Name
{
get => IsDirty ? $"{_name} (unsaved changes)" : _name;
set => SetProperty(ref _name, value);
}
private IViewModelCommand<AppViewModel> _saveCommand;
[IsDirtyIgnored]
[IsReadOnlyIgnored]
public IViewModelCommand<AppViewModel> SaveCommand => _saveCommand ??= new SaveCommand(this)
}
class SaveCommand : AsyncViewModelCommand<AppViewModel>
{
public SaveCommand(AppViewModel context)
{
Context = context;
}
protected override async Task ExecuteAsync(AppViewModel viewModel, object parameter)
{
// SaveChanges(viewModel);
viewModel.IsDirty = false;
}
}
Create a view in XAML for your ViewModel
and enjoy working with bindings.
<Window Title="{Binding Name}">
<Button Command="{Binding SaveCommand}">
</Window>
In case you would like to see a more advanced reference application please don't hesitate to visit my other project Stein.
This library originated in my other project Stein and was subsequently moved to its own repository and nuget package. The goal is to provide a great yet minimal foundation which also promotes a good code style. Nearly everything is marked virtual (except events) so you can customize it to fit your needs.
And of course, this library is 🚀blazing fast🚀.
If you find a bug feel free to open an issue. Contributions are also appreciated.