Add 1200+ line GUIDE.md documenting OpenMaui Linux sample applications. Covers prerequisites, installation, building, and running three sample apps (ShellDemo, TodoApp, WebViewDemo). Includes detailed sections on: - Creating new Linux MAUI applications - Adding OpenMaui Linux support to existing projects - Implementing navigation patterns (Shell and NavigationPage) - Working with themes and styling - API reference for MauiProgram, platform entry points, and dialogs - Troubleshooting common issues Update README.md with improved overview and links to user guide.
29 KiB
OpenMaui Linux Samples - User Guide
A collection of sample applications demonstrating .NET MAUI applications running on Linux using the OpenMaui Linux platform. These samples showcase various MAUI controls, navigation patterns, and features working with SkiaSharp-based rendering on Linux desktop.
Table of Contents
- Overview
- Getting Started
- Sample Applications
- Common Workflows
- Project Structure
- API Reference
- Tips and Best Practices
- Troubleshooting
Overview
This repository contains three production-ready sample applications that demonstrate different aspects of building .NET MAUI applications for Linux:
- ShellDemo: Comprehensive showcase of MAUI controls (buttons, text input, lists, pickers, grids) with Shell-based navigation
- TodoApp: Full-featured task management app demonstrating NavigationPage, MVVM patterns, and data binding
- WebViewDemo: Web browser application showcasing WebKitGTK integration with HTML rendering and JavaScript execution
All samples are built on the OpenMaui.Controls.Linux platform, which brings .NET MAUI to Linux desktop using SkiaSharp for rendering.
Getting Started
Prerequisites
Before you begin, ensure you have the following installed on your Linux system:
- .NET 9.0 SDK or later
- OpenMaui.Controls.Linux package or source
- GTK 3 (for WebView support)
- WebKitGTK (for WebViewDemo)
Install system dependencies on Ubuntu/Debian:
sudo apt-get update
sudo apt-get install dotnet-sdk-9.0 libgtk-3-dev libwebkit2gtk-4.0-dev
Installation
Clone the repository:
git clone https://github.com/openmaui/maui-linux-samples.git
cd maui-linux-samples
The samples support two development modes:
Local Development (with OpenMaui source):
# Clone OpenMaui alongside the samples
cd ..
git clone https://github.com/openmaui/maui-linux.git
cd maui-linux-samples
Package Reference (using NuGet):
# Set environment variable to use package reference
export UsePackageReference=true
Building the Samples
Build all samples in the solution:
dotnet build maui-linux-samples.sln
Build a specific sample:
cd ShellDemo
dotnet build
Build for release:
dotnet build -c Release
Running the Applications
Each sample includes a run.sh script for easy execution:
cd ShellDemo
./run.sh
Or run directly with dotnet:
cd ShellDemo
dotnet run
Run from the compiled output:
cd ShellDemo/bin/Debug/net9.0
./ShellDemo
Sample Applications
ShellDemo
A comprehensive demonstration of MAUI controls and Shell navigation patterns.
Features:
- Shell-based navigation with flyout menu
- Button controls with various styles and events
- Text input controls (Entry, Editor, SearchBar)
- Selection controls (CheckBox, Switch, Slider)
- Pickers (Picker, DatePicker, TimePicker)
- CollectionView with selection and data binding
- Progress indicators (ProgressBar, ActivityIndicator)
- Grid layouts with various sizing options
- Theme switching (Light/Dark mode)
- Push/pop navigation for detail pages
Key Files:
AppShell.xaml- Shell configuration with flyout menuPages/HomePage.xaml- Welcome page with feature cardsPages/ButtonsPage.xaml- Button demonstrationsPages/ListsPage.xaml- CollectionView examplesPages/GridsPage.xaml- Grid layout demonstrations
Running ShellDemo:
cd ShellDemo
./run.sh
Example: Navigating to a detail page
// From any page in ShellDemo
private void OnPushDetailClicked(object? sender, EventArgs e)
{
var success = LinuxViewRenderer.PushPage(new DetailPage("My Item"));
Console.WriteLine($"Navigation result: {success}");
}
Log File Location:
ShellDemo writes diagnostic logs to ~/shelldemo.log for debugging.
TodoApp
A full-featured task management application demonstrating real-world MAUI patterns.
Features:
- NavigationPage-based navigation
- CRUD operations (Create, Read, Update, Delete)
- Data binding with INotifyPropertyChanged
- ObservableCollection for reactive lists
- Custom value converters for UI logic
- Alternating row colors in lists
- Task completion tracking with statistics
- Confirmation dialogs for destructive actions
- Theme support with dynamic color updates
Key Files:
App.xaml.cs- NavigationPage setupTodoItem.cs- Data model with property change notificationsTodoService.cs- Business logic and data managementPages/TodoListPage.xaml- Main list view with statisticsPages/TodoDetailPage.xaml- Task editing and deletionPages/NewTodoPage.xaml- Task creation form
Running TodoApp:
cd TodoApp
./run.sh
Example: Adding a new task
// In NewTodoPage.xaml.cs
private async void OnSaveClicked(object? sender, EventArgs e)
{
var title = TitleEntry.Text?.Trim();
if (string.IsNullOrEmpty(title))
{
TitleEntry.Placeholder = "Title is required!";
TitleEntry.PlaceholderColor = Colors.Red;
return;
}
TodoService.Instance.AddTodo(title, NotesEditor.Text ?? "");
await Navigation.PopAsync();
}
Example: Custom value converter
// Converter for alternating row colors with theme support
public class AlternatingRowColorConverter : IValueConverter
{
public object? Convert(object? value, Type targetType, object? parameter, CultureInfo culture)
{
bool isDarkMode = Application.Current?.RequestedTheme == AppTheme.Dark;
if (value is int index)
{
if (isDarkMode)
return index % 2 == 0 ? Color.FromArgb("#1E1E1E") : Color.FromArgb("#2A2A2A");
return index % 2 == 0 ? Colors.White : Color.FromArgb("#F5F5F5");
}
return isDarkMode ? Color.FromArgb("#1E1E1E") : Colors.White;
}
public object? ConvertBack(object? value, Type targetType, object? parameter, CultureInfo culture)
{
throw new NotImplementedException();
}
}
Log File Location:
TodoApp writes diagnostic logs to ~/todoapp.log.
WebViewDemo
A web browser application showcasing WebKitGTK integration with MAUI.
Features:
- WebView with WebKitGTK backend
- URL navigation with address bar
- Back/forward navigation history
- Page reload functionality
- HTML content loading (local and remote)
- JavaScript execution and evaluation
- Progress indication during page loads
- Theme switching
- Double-click to select all in URL entry
Key Files:
Pages/WebViewPage.xaml- Main browser interfaceProgram.cs- GTK mode initialization for WebView
Running WebViewDemo:
cd WebViewDemo
./run.sh
Example: Loading a URL
private void Navigate()
{
var url = UrlEntry.Text?.Trim();
if (string.IsNullOrEmpty(url))
return;
// Add https:// if not present
if (!url.StartsWith("http://") && !url.StartsWith("https://"))
url = "https://" + url;
MainWebView.Source = new UrlWebViewSource { Url = url };
UrlEntry.Text = url;
}
Example: Loading HTML content
private void OnLoadHtmlClicked(object? sender, EventArgs e)
{
var html = @"
<!DOCTYPE html>
<html>
<head>
<title>OpenMaui WebView</title>
<style>
body { font-family: Arial; margin: 40px; }
h1 { color: #667eea; }
</style>
</head>
<body>
<h1>Hello from OpenMaui Linux!</h1>
<p>This HTML is rendered by WebKitGTK.</p>
</body>
</html>";
MainWebView.Source = new HtmlWebViewSource { Html = html };
}
Example: Evaluating JavaScript
private async void OnEvalJsClicked(object? sender, EventArgs e)
{
try
{
var result = await MainWebView.EvaluateJavaScriptAsync("document.title");
StatusLabel.Text = $"Page title: {result}";
}
catch (Exception ex)
{
StatusLabel.Text = $"Error: {ex.Message}";
}
}
GTK Mode Requirement:
WebViewDemo requires GTK mode to be enabled in Program.cs:
LinuxApplication.Run(app, args, options =>
{
options.UseGtk = true;
});
Log File Location:
WebViewDemo writes diagnostic logs to ~/webviewdemo.log.
Common Workflows
Creating a New Linux MAUI App
Create a new .NET MAUI application that runs on Linux:
Step 1: Create project structure
mkdir MyLinuxApp
cd MyLinuxApp
dotnet new console -n MyLinuxApp
Step 2: Update the .csproj file
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<ApplicationTitle>My Linux App</ApplicationTitle>
<ApplicationId>com.mycompany.mylinuxapp</ApplicationId>
<ApplicationVersion>1.0.0</ApplicationVersion>
<SingleProject>true</SingleProject>
<EnableDefaultXamlItems>true</EnableDefaultXamlItems>
</PropertyGroup>
<PropertyGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
<RuntimeIdentifiers>linux-x64;linux-arm64</RuntimeIdentifiers>
</PropertyGroup>
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
<PackageReference Include="OpenMaui.Controls.Linux" Version="*" />
</ItemGroup>
</Project>
Step 3: Create Program.cs
using Microsoft.Maui.Platform.Linux;
namespace MyLinuxApp;
class Program
{
static void Main(string[] args)
{
var logPath = Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
"mylinuxapp.log");
using var logWriter = new StreamWriter(logPath, append: false) { AutoFlush = true };
var multiWriter = new MultiTextWriter(Console.Out, logWriter);
Console.SetOut(multiWriter);
Console.WriteLine($"Starting MyLinuxApp at {DateTime.Now}");
var app = MauiProgram.CreateMauiApp();
LinuxApplication.Run(app, args);
}
}
class MultiTextWriter : TextWriter
{
private readonly TextWriter[] _writers;
public MultiTextWriter(params TextWriter[] writers) => _writers = writers;
public override System.Text.Encoding Encoding => System.Text.Encoding.UTF8;
public override void Write(char value) { foreach (var w in _writers) w.Write(value); }
public override void WriteLine(string? value) { foreach (var w in _writers) w.WriteLine(value); }
}
Step 4: Create MauiProgram.cs
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Platform.Linux.Hosting;
namespace MyLinuxApp;
public static class MauiProgram
{
public static MauiApp CreateMauiApp()
{
var builder = MauiApp.CreateBuilder();
builder.UseMauiApp<App>();
builder.UseLinux();
return builder.Build();
}
}
Step 5: Create App.xaml and App.xaml.cs
<!-- App.xaml -->
<?xml version="1.0" encoding="utf-8" ?>
<Application xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
x:Class="MyLinuxApp.App">
<Application.Resources>
<ResourceDictionary>
<!-- Add your resources here -->
</ResourceDictionary>
</Application.Resources>
</Application>
// App.xaml.cs
using Microsoft.Maui.Controls;
namespace MyLinuxApp;
public partial class App : Application
{
public App()
{
InitializeComponent();
}
protected override Window CreateWindow(IActivationState? activationState)
{
return new Window(new MainPage());
}
}
Step 6: Build and run
dotnet build
dotnet run
Adding OpenMaui Linux Support
Add Linux support to an existing MAUI project:
Step 1: Update .csproj conditionally
<!-- Linux-specific configuration -->
<PropertyGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
<RuntimeIdentifiers>linux-x64;linux-arm64</RuntimeIdentifiers>
</PropertyGroup>
<!-- Add OpenMaui package for Linux -->
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))">
<PackageReference Include="OpenMaui.Controls.Linux" Version="*" />
</ItemGroup>
Step 2: Update MauiProgram.cs
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Platform.Linux.Hosting;
public static class MauiProgram
{
public static MauiApp CreateMauiApp()
{
var builder = MauiApp.CreateBuilder();
builder.UseMauiApp<App>();
// Add Linux platform support
builder.UseLinux();
return builder.Build();
}
}
Step 3: Create Linux entry point (Program.cs)
using Microsoft.Maui.Platform.Linux;
namespace YourApp;
class Program
{
static void Main(string[] args)
{
var app = MauiProgram.CreateMauiApp();
LinuxApplication.Run(app, args);
}
}
Implementing Navigation
OpenMaui Linux supports multiple navigation patterns:
Shell Navigation (ShellDemo pattern)
// AppShell.xaml
<?xml version="1.0" encoding="UTF-8" ?>
<Shell xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:local="clr-namespace:MyApp"
x:Class="MyApp.AppShell">
<FlyoutItem Title="Home">
<ShellContent ContentTemplate="{DataTemplate local:HomePage}" />
</FlyoutItem>
<FlyoutItem Title="Settings">
<ShellContent ContentTemplate="{DataTemplate local:SettingsPage}" />
</FlyoutItem>
</Shell>
// AppShell.xaml.cs
public partial class AppShell : Shell
{
public AppShell()
{
InitializeComponent();
// Register routes for push navigation
Routing.RegisterRoute("details", typeof(DetailsPage));
}
}
// Navigate using routes
await Shell.Current.GoToAsync("details?id=123");
NavigationPage Pattern (TodoApp pattern)
// App.xaml.cs
protected override Window CreateWindow(IActivationState? activationState)
{
var navigationPage = new NavigationPage(new MainPage())
{
BarBackgroundColor = Color.FromArgb("#5C6BC0"),
BarTextColor = Colors.White
};
return new Window(navigationPage);
}
// Push a new page
await Navigation.PushAsync(new DetailsPage());
// Pop back
await Navigation.PopAsync();
Direct Push/Pop with LinuxViewRenderer
// Push a page directly
var success = LinuxViewRenderer.PushPage(new DetailPage());
// Pop the current page
var success = LinuxViewRenderer.PopPage();
// Navigate to a Shell route
LinuxViewRenderer.NavigateToRoute("settings");
Working with Themes
All samples support Light and Dark themes with dynamic switching.
Step 1: Define theme resources in App.xaml
<Application.Resources>
<ResourceDictionary>
<!-- Light theme colors -->
<Color x:Key="PrimaryLight">#5C6BC0</Color>
<Color x:Key="BackgroundLight">#FFFFFF</Color>
<Color x:Key="TextPrimaryLight">#212121</Color>
<!-- Dark theme colors -->
<Color x:Key="PrimaryDark">#3949AB</Color>
<Color x:Key="BackgroundDark">#121212</Color>
<Color x:Key="TextPrimaryDark">#FFFFFF</Color>
</ResourceDictionary>
</Application.Resources>
Step 2: Use AppThemeBinding in XAML
<Label Text="Hello World">
<Label.TextColor>
<AppThemeBinding Light="{StaticResource TextPrimaryLight}"
Dark="{StaticResource TextPrimaryDark}" />
</Label.TextColor>
</Label>
Step 3: Use SetAppThemeColor in code
var label = new Label { Text = "Hello World" };
label.SetAppThemeColor(
Label.TextColorProperty,
Color.FromArgb("#212121"), // Light
Color.FromArgb("#FFFFFF") // Dark
);
Step 4: Toggle theme programmatically
private void OnThemeToggleClicked(object? sender, EventArgs e)
{
if (Application.Current == null) return;
var currentTheme = Application.Current.UserAppTheme;
var newTheme = currentTheme == AppTheme.Dark ? AppTheme.Light : AppTheme.Dark;
Application.Current.UserAppTheme = newTheme;
}
Step 5: Respond to theme changes
protected override void OnAppearing()
{
base.OnAppearing();
UpdateThemeUI();
}
private void UpdateThemeUI()
{
var isDark = Application.Current?.UserAppTheme == AppTheme.Dark ||
(Application.Current?.UserAppTheme == AppTheme.Unspecified &&
Application.Current?.RequestedTheme == AppTheme.Dark);
ThemeIcon.Source = isDark ? "light_mode.svg" : "dark_mode.svg";
}
Project Structure
All sample projects follow a consistent structure:
SampleApp/
├── Program.cs # Linux platform entry point
├── MauiProgram.cs # MAUI app configuration
├── App.xaml # Application resources and theme
├── App.xaml.cs # Application code-behind
├── AppShell.xaml # Shell navigation (ShellDemo only)
├── Pages/ # Application pages
│ ├── HomePage.xaml
│ ├── HomePage.xaml.cs
│ └── ...
├── Resources/ # Images, icons, fonts
│ ├── AppIcon/
│ └── Images/
├── run.sh # Launch script
└── SampleApp.csproj # Project file
Key Components:
| File | Purpose |
|---|---|
Program.cs |
Platform entry point, sets up logging and exception handling |
MauiProgram.cs |
Configures MAUI app with UseLinux() extension |
App.xaml |
Application-level resources, themes, and styles |
AppShell.xaml |
Shell navigation structure (flyout, tabs, routes) |
*.csproj |
Project configuration with conditional Linux support |
run.sh |
Convenience script for launching the app |
API Reference
MauiProgram Configuration
Configure your MAUI app for Linux in MauiProgram.cs:
using Microsoft.Maui.Hosting;
using Microsoft.Maui.Platform.Linux.Hosting;
public static class MauiProgram
{
public static MauiApp CreateMauiApp()
{
var builder = MauiApp.CreateBuilder();
// Register your app
builder.UseMauiApp<App>();
// Add Linux platform support (registers all handlers)
builder.UseLinux();
// Configure fonts (optional)
builder.ConfigureFonts(fonts =>
{
fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
});
return builder.Build();
}
}
Platform Entry Point
Create a Linux entry point in Program.cs:
using Microsoft.Maui.Platform.Linux;
class Program
{
static void Main(string[] args)
{
// Optional: Set up logging
var logPath = Path.Combine(
Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
"myapp.log");
using var logWriter = new StreamWriter(logPath, append: false) { AutoFlush = true };
var multiWriter = new MultiTextWriter(Console.Out, logWriter);
Console.SetOut(multiWriter);
Console.SetError(multiWriter);
// Optional: Global exception handlers
AppDomain.CurrentDomain.UnhandledException += (sender, e) =>
{
var ex = e.ExceptionObject as Exception;
Console.WriteLine($"[FATAL] Unhandled exception: {ex?.Message}");
};
try
{
var app = MauiProgram.CreateMauiApp();
// Run with default options
LinuxApplication.Run(app, args);
// Or run with GTK mode (required for WebView)
// LinuxApplication.Run(app, args, options =>
// {
// options.UseGtk = true;
// });
}
catch (Exception ex)
{
Console.WriteLine($"[FATAL] Exception in Main: {ex.Message}");
throw;
}
}
}
Navigation APIs
Navigate between pages using these APIs:
LinuxViewRenderer.PushPage
// Push a new page onto the navigation stack
bool success = LinuxViewRenderer.PushPage(new DetailPage());
LinuxViewRenderer.PopPage
// Pop the current page from the navigation stack
bool success = LinuxViewRenderer.PopPage();
LinuxViewRenderer.NavigateToRoute
// Navigate to a registered Shell route
LinuxViewRenderer.NavigateToRoute("settings");
Navigation Property (in NavigationPage)
// Push a page
await Navigation.PushAsync(new DetailPage());
// Pop a page
await Navigation.PopAsync();
// Pop to root
await Navigation.PopToRootAsync();
Shell Navigation
// Navigate to a route
await Shell.Current.GoToAsync("details");
// Navigate with parameters
await Shell.Current.GoToAsync($"details?id={itemId}");
// Navigate back
await Shell.Current.GoToAsync("..");
Dialog Services
Show alerts and confirmation dialogs:
LinuxDialogService.ShowAlertAsync
// Show confirmation dialog
bool confirmed = await LinuxDialogService.ShowAlertAsync(
"Delete Task",
"Are you sure you want to delete this task?",
"Delete",
"Cancel");
if (confirmed)
{
// User clicked "Delete"
DeleteTask();
}
DisplayAlert (MAUI standard)
// Show alert with OK button
await DisplayAlert("Success", "Task saved successfully", "OK");
// Show confirmation dialog
bool answer = await DisplayAlert(
"Confirm",
"Delete this item?",
"Yes",
"No");
Tips and Best Practices
Performance
-
Use compiled bindings for better performance:
<Label Text="{Binding Title, Mode=OneWay}" /> -
Virtualize lists with CollectionView (default behavior):
<CollectionView ItemsSource="{Binding Items}" /> -
Avoid excessive property change notifications:
private string _title; public string Title { get => _title; set { if (_title != value) // Only notify if changed { _title = value; OnPropertyChanged(nameof(Title)); } } }
Logging and Debugging
-
All samples write logs to
~/appname.log:tail -f ~/shelldemo.log -
Add console logging throughout your app:
Console.WriteLine($"[MyPage] Button clicked at {DateTime.Now}"); -
Use global exception handlers (see
Program.csexamples)
Theme Support
-
Always use AppThemeBinding for colors that should change with theme:
<Label.TextColor> <AppThemeBinding Light="#212121" Dark="#FFFFFF" /> </Label.TextColor> -
Test both themes during development:
Application.Current.UserAppTheme = AppTheme.Dark; // Test dark mode -
Update UI when theme changes:
Application.Current.RequestedThemeChanged += (s, e) => { UpdateThemeSpecificUI(); };
Resource Management
-
Use embedded resources for images:
<ItemGroup> <EmbeddedResource Include="Resources/Images/*.svg" /> </ItemGroup> -
Reference images in XAML:
<Image Source="logo.svg" />
Navigation Patterns
- Use Shell for complex navigation (flyout, tabs, routes)
- Use NavigationPage for simple hierarchical navigation
- Register routes for type-safe navigation:
Routing.RegisterRoute("details", typeof(DetailsPage));
Data Binding
-
Implement INotifyPropertyChanged for reactive data:
public class TodoItem : INotifyPropertyChanged { private bool _isCompleted; public bool IsCompleted { get => _isCompleted; set { if (_isCompleted != value) { _isCompleted = value; OnPropertyChanged(nameof(IsCompleted)); } } } public event PropertyChangedEventHandler? PropertyChanged; protected void OnPropertyChanged(string propertyName) { PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName)); } } -
Use ObservableCollection for lists:
public ObservableCollection<TodoItem> Todos { get; } = new();
Troubleshooting
Application won't start
Problem: App crashes immediately on launch
Solutions:
-
Check the log file (
~/appname.log):cat ~/shelldemo.log -
Verify .NET SDK is installed:
dotnet --version -
Ensure OpenMaui package is referenced:
dotnet restore dotnet build -
Check for missing dependencies:
ldd bin/Debug/net9.0/ShellDemo
WebView not working
Problem: WebView shows blank or crashes
Solutions:
-
Verify WebKitGTK is installed:
sudo apt-get install libwebkit2gtk-4.0-dev -
Ensure GTK mode is enabled in
Program.cs:LinuxApplication.Run(app, args, options => { options.UseGtk = true; }); -
Check WebView logs:
cat ~/webviewdemo.log | grep WebView
Navigation not working
Problem: PushPage or PopPage returns false
Solutions:
-
Ensure you're in a NavigationPage or Shell context:
// Check if navigation is available if (Navigation != null) { await Navigation.PushAsync(new DetailPage()); } -
For Shell navigation, register routes:
Routing.RegisterRoute("details", typeof(DetailsPage)); -
Check console output for navigation errors:
grep "Navigation" ~/shelldemo.log
Theme not updating
Problem: UI doesn't update when theme changes
Solutions:
-
Use
AppThemeBindinginstead of static colors:<!-- Wrong --> <Label TextColor="#212121" /> <!-- Correct --> <Label> <Label.TextColor> <AppThemeBinding Light="#212121" Dark="#FFFFFF" /> </Label.TextColor> </Label> -
Subscribe to theme change events:
Application.Current.RequestedThemeChanged += (s, e) => { UpdateUI(); }; -
Force UI refresh in
OnAppearing:protected override void OnAppearing() { base.OnAppearing(); UpdateThemeUI(); }
Build errors on Linux
Problem: Build fails with missing references
Solutions:
-
Restore packages:
dotnet restore -
Clean and rebuild:
dotnet clean dotnet build -
Check .csproj conditional compilation:
<ItemGroup Condition="$([MSBuild]::IsOSPlatform('Linux'))"> <PackageReference Include="OpenMaui.Controls.Linux" Version="*" /> </ItemGroup> -
Verify you're on Linux:
uname -a
Images not displaying
Problem: Images show as blank or missing
Solutions:
-
Check image paths are correct:
<Image Source="logo.svg" /> <!-- Looks in Resources/Images/ --> -
Verify images are included in .csproj:
<ItemGroup> <EmbeddedResource Include="Resources/Images/*.svg" /> </ItemGroup> -
Use absolute paths for testing:
Image.Source = ImageSource.FromFile("/full/path/to/image.png");
Performance issues
Problem: App is slow or unresponsive
Solutions:
-
Use virtualization for long lists (CollectionView does this by default)
-
Avoid binding to expensive properties:
// Bad: Computed property called on every frame public string ExpensiveProperty => ComputeExpensiveValue(); // Good: Cache the value private string _cachedValue; public string CachedProperty => _cachedValue ??= ComputeExpensiveValue(); -
Profile with console timestamps:
var sw = System.Diagnostics.Stopwatch.StartNew(); // ... operation ... Console.WriteLine($"Operation took {sw.ElapsedMilliseconds}ms");
For more information, visit the OpenMaui GitHub repository or check the individual sample README files.