I-Synergy Framework UI

Core UI abstractions and shared components for building cross-platform .NET 10.0 user interfaces. This package provides the foundational layer for all I-Synergy UI implementations including WPF, WinUI, UWP, MAUI, and Blazor.

Features

• Platform-agnostic abstractions for UI services and providers
• Theme management with dynamic accent color support
• Authentication provider for UI security integration
• Token storage service for secure credential management
• ViewModels for common UI scenarios (Language, Theme selection)
• Localization support with built-in resource management
• Extension methods for common UI operations
• Splash screen support with configurable options
• Integration with MVVM framework for ViewModels and services

Installation

Install the package via NuGet:

dotnet add package I-Synergy.Framework.UI

For platform-specific implementations, install the appropriate package:

• WPF: I-Synergy.Framework.UI.WPF
• WinUI: I-Synergy.Framework.UI.WinUI
• UWP: I-Synergy.Framework.UI.UWP
• MAUI: I-Synergy.Framework.UI.Maui
• Blazor: I-Synergy.Framework.UI.Blazor

Quick Start

1. Authentication Provider

The authentication provider enables role-based UI element visibility and command execution control:

using ISynergy.Framework.UI.Abstractions.Providers; using System.Windows.Input; public class CustomAuthenticationProvider : IAuthenticationProvider { private readonly IAuthenticationService _authService; public CustomAuthenticationProvider(IAuthenticationService authService) { _authService = authService; } public bool CanCommandBeExecuted(ICommand command, object commandParameter) { // Implement custom command authorization logic var requiredRole = GetRequiredRoleFromCommand(command); return _authService.CurrentUser.HasRole(requiredRole); } public bool HasAccessToUIElement(object element, object tag, string authorizationTag) { // Implement custom UI element visibility logic if (string.IsNullOrEmpty(authorizationTag)) return true; return _authService.CurrentUser.HasPermission(authorizationTag); } } // Register in DI services.AddScoped<IAuthenticationProvider, CustomAuthenticationProvider>();

2. Theme Management

Use the ThemeViewModel to provide theme and color selection:

using ISynergy.Framework.Core.Abstractions.Services; using ISynergy.Framework.Core.Models; using ISynergy.Framework.UI.ViewModels; using Microsoft.Extensions.Logging; public class ThemeWindow : Window { public ThemeWindow() { InitializeComponent(); } } // In your application public class SettingsViewModel : ViewModel { private readonly IDialogService _dialogService; public AsyncRelayCommand ChangeThemeCommand { get; } public SettingsViewModel( ICommonServices commonServices, ILogger<SettingsViewModel> logger) : base(commonServices, logger) { ChangeThemeCommand = new AsyncRelayCommand(ChangeThemeAsync); } private async Task ChangeThemeAsync() { // Show theme selection dialog await CommonServices.DialogService .ShowDialogAsync<ThemeWindow, ThemeViewModel, ThemeStyle>(); } }

3. Language Selection

Provide multi-language support using the LanguageViewModel:

using ISynergy.Framework.Core.Enumerations; using ISynergy.Framework.UI.ViewModels; public class LanguageWindow : Window { public LanguageWindow() { InitializeComponent(); } } // In your application public class SettingsViewModel : ViewModel { public AsyncRelayCommand ChangeLanguageCommand { get; } public SettingsViewModel( ICommonServices commonServices, ILogger<SettingsViewModel> logger) : base(commonServices, logger) { ChangeLanguageCommand = new AsyncRelayCommand(ChangeLanguageAsync); } private async Task ChangeLanguageAsync() { // Show language selection dialog await CommonServices.DialogService .ShowDialogAsync<LanguageWindow, LanguageViewModel, Languages>(); } }

4. Token Storage Service

Securely store and retrieve authentication tokens:

using ISynergy.Framework.UI.Abstractions.Services; public class AuthenticationService { private readonly ITokenStorageService _tokenStorage; public AuthenticationService(ITokenStorageService tokenStorage) { _tokenStorage = tokenStorage; } public async Task<bool> LoginAsync(string username, string password) { // Perform authentication var token = await _authApi.LoginAsync(username, password); if (token is not null) { // Store tokens securely await _tokenStorage.StoreTokenAsync("access_token", token.AccessToken); await _tokenStorage.StoreTokenAsync("refresh_token", token.RefreshToken); return true; } return false; } public async Task<string> GetAccessTokenAsync() { return await _tokenStorage.GetTokenAsync("access_token"); } public async Task LogoutAsync() { await _tokenStorage.ClearAllTokensAsync(); } }

Core Components

Abstractions

ISynergy.Framework.UI.Abstractions/ ├── Providers/ │ └── IAuthenticationProvider # Command and UI element authorization ├── Services/ │ └── ITokenStorageService # Secure token storage ├── Views/ │ ├── IDashboard # Dashboard view interface │ ├── ISelectionView # Selection view interface │ └── IShellView # Shell/main view interface └── Windows/ └── IThemeWindow # Theme selection window interface

ViewModels

ISynergy.Framework.UI.ViewModels/ ├── ThemeViewModel # Theme and accent color selection └── LanguageViewModel # Language/locale selection

Options

ISynergy.Framework.UI.Options/ ├── BingMapsOptions # Bing Maps API configuration └── SplashScreenOptions # Splash screen configuration

Usage Examples

Splash Screen Configuration

Configure splash screen behavior for your application:

using ISynergy.Framework.UI.Options; using ISynergy.Framework.UI.Enumerations; public void ConfigureServices(IServiceCollection services) { services.Configure<SplashScreenOptions>(options => { options.Type = SplashScreenTypes.Extended; options.DisplayDuration = TimeSpan.FromSeconds(3); options.MinimumDisplayTime = TimeSpan.FromSeconds(1); }); }

Assembly Registration

Register views, viewmodels, and windows from assemblies:

using ISynergy.Framework.UI.Extensions; public void ConfigureServices(IServiceCollection services) { var mainAssembly = Assembly.GetExecutingAssembly(); // Register all views, viewmodels, and windows from assembly services.RegisterAssemblies( mainAssembly, assemblyName => assemblyName.Name.StartsWith("MyApp")); }

Extension Methods

The UI framework provides several useful extension methods:

using ISynergy.Framework.UI.Extensions; // Credential extensions var credential = new Credential { Username = "user", Password = "pass" }; string base64 = credential.ToBase64(); var decoded = base64.FromBase64ToCredential(); // DateTime extensions var now = DateTimeOffset.Now; string formatted = now.ToLocalString(languageService); string dateOnly = now.ToLocalDateString(languageService); // Decimal extensions decimal value = 1234.56m; string currency = value.ToCurrency(languageService); string number = value.ToNumeric(languageService); // Language extensions var german = Languages.German; CultureInfo culture = german.GetCulture(); string displayName = german.GetDescription(); // Telemetry extensions var exception = new InvalidOperationException("Something failed"); exception.Track(); // Tracks exception in telemetry

Configuration

Dependency Injection Setup

Platform-specific setup varies, but the core pattern is:

using ISynergy.Framework.Core.Abstractions.Services; using ISynergy.Framework.Core.Services; using ISynergy.Framework.UI.Abstractions.Providers; using ISynergy.Framework.UI.Providers; using ISynergy.Framework.UI.ViewModels; public void ConfigureServices(IServiceCollection services) { // Core services services.AddSingleton<ILanguageService, LanguageService>(); services.AddSingleton<IInfoService, InfoService>(); services.AddSingleton<IMessengerService, MessengerService>(); // UI services services.AddSingleton<ITokenStorageService, TokenStorageService>(); services.AddScoped<IAuthenticationProvider, AuthenticationProvider>(); // ViewModels services.AddTransient<ThemeViewModel>(); services.AddTransient<LanguageViewModel>(); // Platform-specific services (implemented in UI.WPF, UI.MAUI, etc.) // services.AddSingleton<IDialogService, DialogService>(); // services.AddSingleton<INavigationService, NavigationService>(); // services.AddSingleton<IThemeService, ThemeService>(); }

Best Practices

[!TIP] Use IAuthenticationProvider to centralize authorization logic for both commands and UI elements.

[!IMPORTANT] Always use ITokenStorageService for storing sensitive authentication tokens instead of plain storage mechanisms.

[!NOTE] The UI framework integrates seamlessly with I-Synergy.Framework.Mvvm for ViewModels and commands.

Authentication Provider Usage

• Implement IAuthenticationProvider for centralized authorization
• Use it in command CanExecute delegates
• Bind UI element visibility to authorization checks
• Keep authorization logic testable and maintainable

Theme Management

• Store theme preferences in ISettingsService
• Use ThemeViewModel for user-facing theme selection
• Apply themes through platform-specific IThemeService
• Support both light and dark themes
• Allow custom accent colors

Token Storage

• Never store tokens in plain text
• Use ITokenStorageService for all credentials
• Clear tokens on logout
• Implement token refresh logic
• Handle token expiration gracefully

Platform Integration

This base package is designed to be extended by platform-specific implementations:

Desktop Platforms

• WPF: Full desktop Windows support (.NET 10.0)
• WinUI: Modern Windows apps with WinUI 3
• UWP: Universal Windows Platform apps

Mobile & Cross-Platform

• MAUI: Cross-platform for Windows, Android, iOS, macOS
• Blazor: Web-based UI with WebAssembly or Server

Each platform implementation provides:

• Platform-specific services (Dialog, Navigation, Theme, File)
• Custom controls and styles
• Platform integration features
• Build configurations and assets

Dependencies

• I-Synergy.Framework.Mvvm - MVVM framework integration
• I-Synergy.Framework.OpenTelemetry - Telemetry and observability
• Microsoft.Extensions.Http - HTTP client factory
• Microsoft.Extensions.Logging - Logging infrastructure
• NodaTime - Date and time handling
• OpenTelemetry.Instrumentation.Http - HTTP telemetry
• OpenTelemetry.Instrumentation.Runtime - Runtime telemetry

Documentation

For more information about the I-Synergy Framework:

• Framework Documentation
• API Reference
• Sample Applications

Related Packages

Core Frameworks

• I-Synergy.Framework.Core - Core abstractions and services
• I-Synergy.Framework.Mvvm - MVVM framework

Platform-Specific UI

• I-Synergy.Framework.UI.Maui - .NET MAUI implementation
• I-Synergy.Framework.UI.WPF - WPF implementation
• I-Synergy.Framework.UI.WinUI - WinUI 3 implementation
• I-Synergy.Framework.UI.UWP - UWP implementation
• I-Synergy.Framework.UI.Blazor - Blazor implementation

Other Frameworks

• I-Synergy.Framework.CQRS - CQRS pattern implementation
• I-Synergy.Framework.AspNetCore - ASP.NET Core integration

Support

For issues, questions, or contributions, please visit the GitHub repository.