Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: SyncFusion single project changes + updating license note #2336

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: SyncFusion single project changes + updating license note #2336

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eb66b9
docs: fixing license note
Kunal22shah Jun 11, 2024
77d65eb
docs: single project changes
Kunal22shah Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 62 additions & 21 deletions doc/Learn/Maui/ThirdParty-Synfusion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,65 @@ The controls from Syncfusion .NET MAUI Controls can be used in an Uno Platform a

An existing sample app that showcases the controls is available [here](https://github.com/unoplatform/Uno.Samples/tree/master/UI/MauiEmbedding/SyncfusionApp).

> [!NOTE]
> SyncFusionApp SDK for .NET is currently only compatible with Windows, Android, iOS, and Mac Catalyst when used with Uno Platform.

## Installation

In order to use the Syncfusion controls, you will need to create an account and purchase a Syncfusion license [here](https://help.syncfusion.com/maui/licensing/overview). This sample can be run in development without a license key.

## Getting Started

1. Create a new application using the `unoapp` template, enabling .NET MAUI Embedding. In this case, we're going to use the Blank template (`-preset blank`) and include .NET MAUI Embedding support (`-maui`).
### [Visual Studio](#tab/vs)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as #2322 (comment)


```dotnetcli
dotnet new unoapp -preset blank -maui -o MauiEmbeddingApp
```
> [!NOTE]
> If you don't have the **Uno Platform Extension for Visual Studio** installed, follow [these instructions](xref:Uno.GetStarted.vs2022).

- Launch **Visual Studio** and click on **Create new project** on the Start Window. Alternatively, if you're already in Visual Studio, click **New, Project** from the **File** menu.

- Type `Uno Platform` in the search box

- Click **Uno Platform App**, then **Next**

- Name the project `SyncFusionApp` and click **Create**

At this point you'll enter the **Uno Platform Template Wizard**, giving you options to customize the generated application.

- Select **Blank** in **Presets** selection

- Select the **Platforms** tab and unselect **Desktop** and **Web Assembly** platforms

- Select the **Features** tab and click on **.NET MAUI Embedding**

- Click **Create** to complete the wizard

1. Next, add a reference to the [Syncfusion.Maui.Charts package](https://www.nuget.org/packages/Syncfusion.Maui.Charts) to the `MauiEmbeddingApp.MauiControls` project.
The template will create a solution with a single cross-platform project, named `SyncFusionApp`, ready to run.

1. In the `AppBuilderExtensions` class, on `MauiEmbeddingApp.MauiControls` project, update the `UseMauiControls` extension method to call the `ConfigureSyncfusionCore` method.
For more information on all the template options, see [Using the Uno Platform Template](xref:Uno.GettingStarted.UsingWizard).

### [Command Line](#tab/cli)

> [!NOTE]
> If you don't have the **Uno Platform dotnet new templates** installed, follow [dotnet new templates for Uno Platform](xref:Uno.GetStarted.dotnet-new).

Create a new application using the `unoapp` template, enabling .NET MAUI Embedding. In this case, we're going to use the Blank template (`-preset blank`) and include .NET MAUI Embedding support (`-maui`).

```bash
dotnet new unoapp -preset blank -maui -platforms "android" -platforms "ios" -platforms "maccatalyst" -platforms "windows" -o SyncFusionApp
```

This will create a new folder called **SyncFusionApp** containing the new application.

---

1. Next, add a reference to the [Syncfusion.Maui.Charts package](https://www.nuget.org/packages/Syncfusion.Maui.Charts) to the `SyncFusionApp.MauiControls` project.

1. In the `AppBuilderExtensions` class, on `SyncFusionApp.MauiControls` project, update the `UseMauiControls` extension method to call the `ConfigureSyncfusionCore` method.

```cs
using Syncfusion.Maui.Core.Hosting;

namespace MauiEmbeddingApp;
namespace SyncFusionApp;

public static class AppBuilderExtensions
{
Expand All @@ -37,24 +76,24 @@ using Syncfusion.Maui.Core.Hosting;
.ConfigureSyncfusionCore()
.ConfigureFonts(fonts =>
{
fonts.AddFont("MauiEmbeddingApp/Assets/Fonts/OpenSansRegular.ttf", "OpenSansRegular");
fonts.AddFont("MauiEmbeddingApp/Assets/Fonts/OpenSansSemibold.ttf", "OpenSansSemibold");
fonts.AddFont("Assets/Fonts/OpenSansRegular.ttf", "OpenSansRegular");
fonts.AddFont("Assets/Fonts/OpenSansSemibold.ttf", "OpenSansSemibold");
});
}
```

## Adding SfCircularChart

1. Update the EmbeddedControl.xaml in the `MauiEmbeddingApp.MauiControls` project with the following XAML that includes the `SfCircularChart` control, which will be used to display a doughnut shaped chart.
1. Update the EmbeddedControl.xaml in the `SyncFusionApp.MauiControls` project with the following XAML that includes the `SfCircularChart` control, which will be used to display a doughnut shaped chart.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<ContentView xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
x:Class="MauiEmbeddingApp.MauiControls.EmbeddedControl"
x:Class="SyncFusionApp.MauiControls.EmbeddedControl"
xmlns:chart="http://schemas.syncfusion.com/maui"
xmlns:local="clr-namespace:MauiEmbeddingApp.MauiControls.ViewModels"
xmlns:local="clr-namespace:SyncFusionApp.MauiControls.ViewModels"
HorizontalOptions="Fill"
VerticalOptions="Fill">
<chart:SfCircularChart x:Name="chart"
Expand Down Expand Up @@ -118,7 +157,7 @@ using Syncfusion.Maui.Core.Hosting;
1. Update the EmbeddedControl.xaml.cs with the following code.

```cs
namespace MauiEmbeddingApp.MauiControls;
namespace SyncFusionApp.MauiControls;

public partial class EmbeddedControl : ContentView
{
Expand All @@ -129,16 +168,16 @@ using Syncfusion.Maui.Core.Hosting;
}
```

1. It's time to create the ViewModel that will hold the properties that will be data bound to the `SfCircularChart` control. In `MauiEmbeddingApp.MauiControls` project, create a new folder called `ViewModels` and add a new class called `EmbeddedViewModel`. This class will have the following code:
1. It's time to create the ViewModel that will hold the properties that will be data bound to the `SfCircularChart` control. In `SyncFusionApp.MauiControls` project, create a new folder called `ViewModels` and add a new class called `EmbeddedViewModel`. This class will have the following code:

```cs
using MauiEmbeddingApp.MauiControls.Models;
using SyncFusionApp.MauiControls.Models;
using Syncfusion.Maui.Charts;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Windows.Input;

namespace MauiEmbeddingApp.MauiControls.ViewModels;
namespace SyncFusionApp.MauiControls.ViewModels;

public class EmbeddedViewModel : INotifyPropertyChanged
{
Expand Down Expand Up @@ -336,10 +375,10 @@ using Syncfusion.Maui.Core.Hosting;
}
```

1. The `EmbeddedViewModel` class is dependent on a `ChartDataModel` class which needs to be created. In `MauiEmbeddingApp.MauiControls` project, create a new folder called `Models` and add a new class called `ChartDataModel`. This class will have the following code:
1. The `EmbeddedViewModel` class is dependent on a `ChartDataModel` class which needs to be created. In `SyncFusionApp.MauiControls` project, create a new folder called `Models` and add a new class called `ChartDataModel`. This class will have the following code:

```cs
namespace MauiEmbeddingApp.MauiControls.Models;
namespace SyncFusionApp.MauiControls.Models;

public class ChartDataModel
{
Expand Down Expand Up @@ -477,7 +516,7 @@ using Syncfusion.Maui.Core.Hosting;

```xml
<?xml version="1.0" encoding="utf-8" ?>
<ContentView x:Class="MauiEmbeddingApp.MauiControls.EmbeddedControl"
<ContentView x:Class="SyncFusionApp.MauiControls.EmbeddedControl"
...
>
<chart:SfCircularChart x:Name="chart"
Expand All @@ -492,10 +531,10 @@ using Syncfusion.Maui.Core.Hosting;
1. Now the project is good to go! Press F5 and you should see the `SfCircularChart` control. Without specifying a license key, you'll see a prompt informing you that you're running the application using a trial version.

> [!NOTE]
> There is a known issue with the trial version prompt that can cause the application to crash on startup. If this is encountered running this sample, the `MainPage.xaml` can be updated to remove the `Source` property on the `MauiHost`. The `Source` property can then be set in the codebehind file in an event handler for the `Loaded` event of the `Page`.
> When running on Windows without a valid Syncfusion license (in demo mode) the app will crash due to the Demo Mode dialog being launched too early. You can work around this by setting the Control Type in your MauiHost from the Loaded event.

```cs
namespace MauiEmbeddingApp;
namespace SyncFusionApp;

public sealed partial class MainPage : Page
{
Expand All @@ -513,6 +552,8 @@ using Syncfusion.Maui.Core.Hosting;
}
```

For more detailed instructions specific to each platform, refer to the [Debug the App](xref:Uno.GettingStarted.CreateAnApp.VS2022#debug-the-app) documentation.

**App Render Output**

- **Android:**
Expand Down
Loading