https://github.com/NeverMorewd/Lemon.ModuleNavigation
A lightweight module navigation framework built on top of the Microsoft Dependency Injection (MSDI) for AvaloniaUI, WPF and .net-xaml-platforms else. Support nativeAot
https://github.com/NeverMorewd/Lemon.ModuleNavigation
Last synced: 3 months ago
JSON representation
A lightweight module navigation framework built on top of the Microsoft Dependency Injection (MSDI) for AvaloniaUI, WPF and .net-xaml-platforms else. Support nativeAot
- Host: GitHub
- URL: https://github.com/NeverMorewd/Lemon.ModuleNavigation
- Owner: NeverMorewd
- License: mit
- Created: 2024-09-27T10:37:27.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-02-14T15:39:06.000Z (4 months ago)
- Last Synced: 2025-02-25T05:01:39.965Z (3 months ago)
- Language: C#
- Homepage:
- Size: 498 KB
- Stars: 36
- Watchers: 1
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-avalonia - Lemon.ModuleNavigation - .NET Generic Host support for Avaloniaui app. (Libraries & Extensions / Generic)
README
# Lemon.ModuleNavigation
[](https://www.nuget.org/packages/Lemon.ModuleNavigation/)
## Language
- [English](#english)
- [中文](#中文)
---
### English
## Introduction
### Lemon.ModuleNavigation
A lightweight module navigation framework built on top of the Microsoft Dependency Injection (MSDI) for AvaloniaUI, WPF and .net-xaml-platforms else.
Support native aot (Avaloniaui)
### Lemon.ModuleNavigation.AvaloniaUI
Extending `Lemon.ModuleNavigation`, this package provides handy NavigationContainers specifically designed for AvaloniaUI.
### Key Advantages:
- **Lightweight**: Minimal performance overhead.
- **Commonly module options are provided**:LoadonDemand; Unload; Multi-Instance.
- **Few dependencies**: Only relies on `Microsoft.Extensions.DependencyInjection.Abstractions`.
- **Framework Agnostic**: Does not enforce any specific MVVM framework, allowing developers to use the MVVM framework of their choice.
- **Highly Extensible**: Easily customizable to suit specific needs.
- **Simple to Use**.
---
ModuleNavigation screenshot:
ViewNavigation screenshot:
---
### Usage:
#### Create module with View and ViewModel
##### Module.cs
```csharp
using System;
using Lemon.ModuleNavigation.Avaloniaui;
namespace Lemon.ModuleNavigation.Sample.ModuleAs
{
public class ModuleA : AvaModule
{
public ModuleA(IServiceProvider serviceProvider) : base(serviceProvider)
{
}
///
/// Specifies whether this module needs to be loaded on demand
/// Default value is True
///
public override bool LoadOnDemand => false;
///
/// Alias of module for displaying usually
/// Default value is class name of Module
///
public override string? Alias => base.Alias;
///
/// Specifies whether this module allow multiple instances
/// If true,every navigation to this module will generate a new instance.
/// Default value is false.
///
public override bool ForceNew => base.ForceNew;
///
/// Specifies whether this module can be unloaded.
/// Default value is false.
///
public override bool CanUnload => base.CanUnload;
///
/// Initialize
///
public override void Initialize()
{
base.Initialize();
}
}
}
```
##### View.cs
```csharp
using Avalonia.Controls;
using Lemon.ModuleNavigation.Abstracts;
namespace Lemon.ModuleNavigation.Sample.ModuleAs;
public partial class ViewA : UserControl, IView
{
public ViewA()
{
InitializeComponent();
}
}
```
##### ViewModel.cs
```csharp
using Lemon.ModuleNavigation.Abstracts;
using Lemon.ModuleNavigation.Sample.ViewModels;
using System;
namespace Lemon.ModuleNavigation.Sample.ModuleAs
{
public class ViewModelA : IViewModel
{
public void Dispose()
{
}
}
}
```
#### In MainView.axaml or MainWindow.axaml
##### ContentControl
```xaml
```
##### TabControl
```xaml
```
#### MainViewModel.cs
```csharp
public class MainViewModel : ViewModelBase, IServiceAware
{
private readonly NavigationService _navigationService;
private readonly IServiceProvider _serviceProvider;
private readonly IDialogService _dialogService;
private readonly ILogger _logger;
public MainViewModel(IEnumerable modules,
IServiceProvider serviceProvider,
NavigationService navigationService,
IDialogService dialogService,
ILogger logger)
{
_logger = logger;
_navigationService = navigationService;
_serviceProvider = serviceProvider;
_dialogService = dialogService;
Modules = new ObservableCollection(modules);
}
///
/// IServiceAware
///
public IServiceProvider ServiceProvider => _serviceProvider;
///
/// Navigation is triggered based on the timing of the customization
///
public void OnSelectedModuleChanged(IModule? selectedModule)
{
_navigationService.NavigateTo(selectedModule!);
}
///
/// For binding
///
public ObservableCollection Modules
{
get;
set;
}
}
```
### With generic host. Using `Lemon.Hosting.AvaloniaUIDesktop`
#### Program.cs in `Lemon.ModuleNavigation.Sample.DesktopHosting`
```csharp
class Program
{
[STAThread]
[SupportedOSPlatform("windows")]
[SupportedOSPlatform("linux")]
[SupportedOSPlatform("macos")]
public static void Main(string[] args)
{
var hostBuilder = Host.CreateApplicationBuilder();
// module navigation
hostBuilder.Services.AddAvaNavigationSupport();
// modules
hostBuilder.Services.AddModule();
hostBuilder.Services.AddModule();
hostBuilder.Services.AddModule();
// views
hostBuilder.Services.AddView(nameof(ViewAlpha));
hostBuilder.Services.AddView(nameof(ViewAlpha));
hostBuilder.Services.AddAvaloniauiDesktopApplication(BuildAvaloniaApp);
hostBuilder.Services.AddMainWindow();
var appHost = hostBuilder.Build();
appHost.RunAvaloniauiApplication(args);
}
public static AppBuilder BuildAvaloniaApp(AppBuilder appBuilder)
{
return appBuilder
.UsePlatformDetect()
.WithInterFont()
.LogToTrace()
.UseReactiveUI();
}
}
```
### Without generic host
#### AppWithDI.xaml.cs in `Lemon.ModuleNavigation.Sample`
```csharp
public partial class AppWithDI : Application
{
private IServiceProvider? _serviceProvider;
public override void Initialize()
{
AvaloniaXamlLoader.Load(this);
}
public override void OnFrameworkInitializationCompleted()
{
var services = new ServiceCollection();
services.AddNavigationContext()
.AddModule()
.AddSingleton()
.AddSingleton()
.AddSingleton();
_serviceProvider = services.BuildServiceProvider();
var viewModel = _serviceProvider.GetRequiredService();
switch (ApplicationLifetime)
{
case IClassicDesktopStyleApplicationLifetime desktop:
var window = _serviceProvider.GetRequiredService();
window.DataContext = viewModel;
desktop.MainWindow = window;
break;
case ISingleViewApplicationLifetime singleView:
var view = _serviceProvider.GetRequiredService();
view.DataContext = viewModel;
singleView.MainView = view;
break;
}
base.OnFrameworkInitializationCompleted();
}
}
```
### Lemon.Extensions.ModuleNavigation.Sample.Desktop
A sample desktop application for `Lemon.ModuleNavigation` and `Lemon.ModuleNavigation.AvaloniaUI`.
### Lemon.Extensions.ModuleNavigation.Sample.DesktopHosting
A sample desktop application for `Lemon.ModuleNavigation` and `Lemon.ModuleNavigation.AvaloniaUI` using AvaloniaUI.
It introduces `Lemon.Hosting.AvaloniaUIDesktop` to support .NET Generic Host.
#### AOT config:
Update .csproj
```xml
...
true
true
...
true
true
```
Add rd.xml
```xml
```
### [Lemon.Toolkit](https://github.com/NeverMorewd/Lemon.Toolkit)
This is a practical application of `Lemon.ModuleNavigation`. It is a collection of toolkits for clients based on `Semi-Avaloniaui`, `Lemon.Hosting.AvaloniaUIDesktop`, and `Lemon.ModuleNavigation`. As of now, it includes:
- Module navigation based on NTabContainer
- Custom HomeModule
- Custom console log
- File Inspector (ongoing)
- File Comparer (ongoing)
- ...
---
### 中文
## 简介
### Lemon.ModuleNavigation
**Lemon.ModuleNavigation** 是一个基于微软依赖注入（MSDI）的轻量级模块导航框架，专为 AvaloniaUI、WPF 和其他 .NET XAML 平台设计。它支持 **Native AOT**，为 AvaloniaUI 提供高效的导航，性能开销极低。
### Lemon.ModuleNavigation.AvaloniaUI
**Lemon.ModuleNavigation** 的扩展包，专为 AvaloniaUI 提供特定的 **NavigationContainers**，使得模块导航更加无缝且灵活。
### 主要优势：
- **轻量级**：最小的性能开销。
- **依赖少**：只依赖 `Microsoft.Extensions.DependencyInjection.Abstractions`。
- **框架无关**：不强制使用任何特定的 MVVM 框架，允许开发者选择自己喜欢的 MVVM 框架。
- **高度可扩展**：可以轻松定制以满足特定需求。
- **简单易用**。
---