Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zleao/zoft.mauiextensions
Extension library intended to be used with MAUI. Extra functionality for Views, ViewModels and Services.
https://github.com/zleao/zoft.mauiextensions
csharp dotnet maui net8
Last synced: 22 days ago
JSON representation
Extension library intended to be used with MAUI. Extra functionality for Views, ViewModels and Services.
- Host: GitHub
- URL: https://github.com/zleao/zoft.mauiextensions
- Owner: zleao
- License: mit
- Created: 2021-06-24T12:05:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T11:15:08.000Z (about 1 month ago)
- Last Synced: 2024-12-02T03:51:02.051Z (27 days ago)
- Topics: csharp, dotnet, maui, net8
- Language: C#
- Homepage:
- Size: 293 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# zoft.MauiExtensions
Set of tools designed to be used in MAUI projects, including Views, ViewModels, Services, Extensions and more...
Nuget Package | Current Version
--- | ---
| zoft.MauiExtensions.Core | [](https://www.nuget.org/packages/zoft.MauiExtensions.Core/)
## Getting Started
### Install nuget package: [zoft.MauiExtensions.Core](https://www.nuget.org/packages/zoft.MauiExtensions.Core/)
```
Install-Package zoft.MauiExtensions.Core
```
### Create Windows `MainThreadService`
```csharp
using Microsoft.UI.Dispatching;
using zoft.MauiExtensions.Core.Services;
namespace .Platforms.Windows.Services
{
public sealed class WindowsMainThreadService : MainThreadService
{
protected override DispatcherQueue MainThreadDispatcher => WinUI.App.Dispatcher;
}
}
```
### Register `MainThreadService` depending on platform
```csharp
return builder
.UseMauiApp()
.ConfigureFonts(fonts =>
{
fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
})
#if WINDOWS
.Services.AddSingleton();
#else
.Services.AddSingleton();
#endif
.Build();
```
## How To Use
Refer to the sample to have a better understanding of package capabilities. Bellow you can find the most common features and how to use them
### Localization Service
The package provides a set of tools to implement localization in your app:
- `ILocalizationService`: Interface for the localization service. The interface exists to make it easier to use iwith IOC and to override the base implementation
- `ResourceManagerLocalizationService`: Implementation of the `ILocalizationService` using resource files (*.resx*)
```csharp
builder.Services.AddSingleton(new ResourceManagerLocalizationService(AppResources.ResourceManager, SupportedLanguages.DefaultLanguage));
```
- `TranslationMarkup`: XAML markup that provides an easy way to apply the translation directly in XAML
```xaml
...
...
...
```
### MainThread Service
At current time, the MAUI essentials implementation of `MainThread` is not working for Windows. This package provides a wrapper interface `IMainThreadService` and an implementation for all platforms, including Windows.
To use, you just need to register the correct service depending of the platform:
```csharp
public sealed class WindowsMainThreadService : MainThreadService
{
protected override DispatcherQueue MainThreadDispatcher => WinUI.App.Dispatcher;
}
```
### Base Models
Based on the Component Models of the [CommunityToolkit.MVVM](), the package provides a set of base models that can be used to create Models, ViewModels and Services in your app.
- **ZoftObservableObject**: Based on the `ObservableObject` class, provides a base implementation of the `INotifyPropertyChanged` interface
- **ZoftObservableRecipient**: Based on the `ObservableRecipient` class, provides a base implementation of the `ObservableRecipient` class
- **ZoftObservableValidator**: Based on the `ObservableValidator` class, provides a base implementation of the `ObservableValidator` class
- Override `OnErrorsChanged` to handle logic when the validation results change
### Busy Notification Management
Base models provide methods to execute code in a background thread, while providing with updated on `IsBusy` and `BusyMessage` properties that can be bound to an UI element (i.e. `ActivityIndicator`)
```csharp
await DoWorkAsync(() => ..., "Busy Message");
var result = await DoWorkAsync(() => return some_object, "BusyMessage");
```
### Weak Subscription
The package provides a set of extension methods to subscribe to events using weak references, avoiding memory leaks when the subscriber is not disposed.