Development Guide

October 18, 2024 · View on GitHub

This page contains the steps to build and run the Syncfusion Toolkit for .NET MAUI repository from source. If you are looking to build apps with the Syncfusion Toolkit for .NET MAUI, please head over to the links in the README to get started.

Initial setup

Windows

Install VS 17.10 or newer.
- Follow these steps to include MAUI.
If building iOS with pair to Mac, install current, stable Xcode on your Mac. Install from the App Store or Apple Developer portal.
If you're missing any of the Android SDKs, Visual Studio should prompt you to install them. If it doesn't prompt you, then use the Android SDK Manager to install the necessary SDKs.
Install Open JDK 17.

Mac

Install VSCode.
Follow the steps for installing the .NET MAUI Dev Kit for VS Code: https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-maui

Building the Build Tasks

Before opening the solution in Visual Studio/VS Code, you MUST build the build tasks.

Open a command prompt/terminal/shell window.
Navigate to the location of your cloned syncfusion/maui-toolkit repo, for example:
```
cd \repos\maui-toolkit
```

Run these commands:

dotnet tool restore
dotnet build ./Syncfusion.Maui.Toolkit.sln

Windows

Open the Syncfusion.Maui.Toolkit.sln file in Visual Studio from the root of the repo.

Mac

Open the root folder of the repository in VS Code.

What branch should I use?

As a general rule:

main

Sample projects

Samples

├── samples 
│   ├── Syncfusion.Maui.ControlsGallery
│   ├── Syncfusion.Maui.Controls.Samples.Sandbox
│   │   ├── Maui.Controls.Sample.Sandbox

Syncfusion.Maui.ControlsGallery: Full gallery sample with all of the controls and features of the Syncfusion .NET MAUI Toolkit.
Syncfusion.Maui.Samples.Sandbox: Empty project useful for testing reproductions or use cases.