Getting Started with Syncfusion .NET MAUI

A comprehensive guide for installing, configuring, and setting up your development environment for Syncfusion .NET MAUI components

When to Use This Skill

ALWAYS use this skill immediately when the user needs to:

Install or Setup: NuGet packages, installers (web, offline, Mac), installation troubleshooting
License: Generate license keys, register keys in applications, resolve licensing errors, trial to paid upgrades
Theme: Apply Material/Cupertino themes, light/dark modes, customize theme colors, override theme keys
AI Integration: Configure Azure OpenAI, Claude, Gemini, DeepSeek, Groq, or custom AI services for Smart Components
Tooling: Use Visual Studio or VS Code extensions, project templates, code snippets, Essential UI Kit
Advanced: Implement Liquid Glass UI, upgrade NuGet packages, handle breaking changes
Troubleshoot: Installation errors, licensing issues, theme problems, AI service configuration

This skill contains cross-cutting concerns that apply to all Syncfusion .NET MAUI components and applications.

Overview of Syncfusion .NET MAUI

Syncfusion .NET MAUI (Multi-platform App UI) is a comprehensive collection of high-performance, feature-rich UI components for building native cross-platform applications. Built on Microsoft's .NET MAUI framework, it enables developers to create modern, beautiful applications with a single codebase targeting:

Windows (desktop applications)
macOS (desktop applications)
iOS (mobile applications)
Android (mobile applications)

Key Capabilities

70+ Components: Grids, charts, gauges, editors, calendars, schedulers, and more
Native Performance: Platform-specific optimizations for smooth UX
Consistent API: Single codebase works across all platforms
Theme Support: Material Design and Cupertino (iOS-style) themes with light/dark modes
AI-Powered: Smart Components with AI service integration
Accessibility: WCAG-compliant with screen reader support
Localization: RTL and multi-language support

Component Categories

Syncfusion .NET MAUI includes components across multiple categories:

Data Visualization (Charts, Gauges, TreeMap)
Grids & Data (DataGrid, ListView, TreeView)
Editors & Inputs (TextBox, ComboBox, DatePicker, Autocomplete)
Calendars & Scheduling (Calendar, Scheduler, DateRangePicker)
Navigation (TabView, TreeView, Accordion, Carousel)
Layout (Cards, Chips, Avatar, Backdrop)
Buttons & Indicators (Button, Checkbox, RadioButton, Badge, Busy Indicator)
File Formats (PDF, Excel, Word, PowerPoint)

Platform Support & Requirements

Supported Platforms

Platform	Minimum Version	Recommended
Windows	Windows 10 version 1809+	Windows 11
macOS	macOS 10.15+	macOS 12+
iOS	iOS 11+	iOS 15+
Android	Android 5.0 (API 21)+	Android 12+ (API 31+)

Framework Compatibility

Syncfusion .NET MAUI supports:

.NET 6 (initial MAUI support)
.NET 7 (enhanced features)
.NET 8 (LTS with full feature set)
.NET 9 (latest features) .NET 10 (latest features)

Development Environment

Windows Development:

Visual Studio 2022 (v17.3+) for .NET 9, or Visual Studio 2026 for .NET 10
.NET MAUI workload installed
Android SDK (for Android development)

macOS Development:

Visual Studio Code with .NET MAUI extension
Xcode 13+ (for iOS/macOS development)
.NET MAUI workload installed

Cross-Platform:

Visual Studio Code with .NET MAUI extension
.NET SDK 9.0+ (or 10.0+ for .NET 10 features)

System Requirements

📄 For complete system requirements, read: references/introduction-overview.md

Getting Started Guide

Quick Start (3 Steps)

Step 1: Install NuGet Package

dotnet add package Syncfusion.Maui.Core
# Or install specific component packages as needed

Step 2: Register License Key (Required for v20.2.0.x+)

In MauiProgram.cs, add before CreateMauiApp():

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        // Register Syncfusion license
        Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR_LICENSE_KEY");
        
        var builder = MauiApp.CreateBuilder();
        // ... rest of configuration
    }
}

Step 3: Apply Theme (Optional but recommended)

In App.xaml:

<Application xmlns:syncTheme="clr-namespace:Syncfusion.Maui.Themes;assembly=Syncfusion.Maui.Core">
    <Application.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <syncTheme:SyncfusionThemeResourceDictionary VisualTheme="MaterialLight"/>
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Application.Resources>
</Application>