Provides a framework for implementing the MVVM design pattern in .NET applications. Includes base classes for view models, command implementations, asynchronous collection support, and utilities for data binding and property change notification.
Get Started
$ dotnet add package Oakrey.ViewModelsReadme
Oakrey.ViewModels
1. Overview
The "ViewModels" project provides a robust framework for implementing the MVVM (Model-View-ViewModel) design pattern in .NET applications. It simplifies the development of maintainable and testable WPF applications by offering essential components like commands, collections, and base classes.
2. Features
Base Classes:
- ViewModelBase provides property change notification and serves as a foundation for creating view models.
Command Implementation:
- RelayCommand and RelayCommandGeneric enable binding actions to UI elements with minimal boilerplate code.
- CommandBase offers a customizable base class for commands.
Asynchronous Support:
- AsyncObservableCollection supports thread-safe and asynchronous operations on observable collections.
- AsyncDispatcherEvent facilitates event handling in asynchronous scenarios.
Collection Utilities:
- ObservableQueue provides an observable queue implementation for dynamic data binding.
- CollectionsExtensions includes helper methods for working with collections.
Error Handling:
AsyncCollectionException provides structured exception handling for asynchronous collection operations.
3. Installation
You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.
NuGet Package Manager
- Open your project in Visual Studio.
- Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
- Search for
Oakrey.ViewModelsand click Install.
.NET CLI
Run the following command in your terminal:
dotnet add package Oakrey.ViewModels
Package Manager Console
Run the following command in your Package Manager Console:
Install-Package Oakrey.ViewModels
4. Requirements
- .NET 8 or higher
5. Project Information
- Author: Oakrey
- Company: Oakrey (Website Link)
- License: MIT
- Repository: Git Repository
- Project URL: Project Website
6. Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.
7. License
This project is licensed under the MIT License. See the LICENSE file for details.