Add New .NET MAUI Template with Syncfusion Toolkit Integration #25419

PaulAndersonS · 2024-10-21T13:12:15Z

This PR introduces a fully featured sample app as part of the new .NET MAUI project experience. When you choose to include the sample content in a new .NET MAUI project, you will find a fully functional to-do app that will bring balance to every .NET developer's life. You can create projects, and projects can have tasks. It uses controls from the new Syncfusion Toolkit for .NET MAUI to visualize the data. and to persist the data we use a local database based on SQLite. Furthermore, the sample app uses common patterns, like MVVM, and libraries that you will find in almost every .NET MAUI application.

The libraries that are included in the sample content are:

Syncfusion Toolkit for .NET MAUI
.NET MAUI Community Toolkit
CommunityToolkit.Mvvm
SQLite

We believe that this sample app will give you a flying start when you begin working with .NET MAUI.

When creating a new .NET MAUI project from Visual Studio, you can check the box to include all this sample code and get a sense of what an actual .NET MAUI project looks like. Also, dotnet new maui from the command line will now include this content. If you wish to opt-out you can do dotnet new maui --empty or, when using Visual Studio, you can uncheck the box.

…sion Toolkit

dotnet-policy-service · 2024-10-21T13:12:53Z

Hey there @PaulAndersonS! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

PaulAndersonS · 2024-10-21T13:17:01Z

@dotnet-policy-service agree

davidortinau · 2024-10-21T13:27:26Z

Thanks @PaulAndersonS!

Everyone, please review and comment especially on the guidance and patterns this template provides.

Providing a more full featured sample in the templates is something we are often asked for by developers (often in their learning journey), while also retaining the empty template.

jsuarezruiz

It's really nice to see a more complex template with more possibilities!

jsuarezruiz · 2024-10-21T13:41:44Z

src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.en.json

@@ -3,7 +3,13 @@
  "name": ".NET MAUI App",
  "description": "A project for creating a .NET MAUI application for iOS, Android, Mac Catalyst, WinUI and Tizen",


It's the same description as the default project

maui/src/Templates/src/templates/maui-mobile/.template.config/template.json

Line 9 in 70f1f76

"description": "A project for creating a .NET MAUI application for iOS, Android, Mac Catalyst, WinUI and Tizen",

, shouldn't it be different? mention the use of the Syncfusion Toolkit etc?

"A project template for creating a .NET MAUI application that includes Syncfusion Toolkit integration, supporting iOS, Android, Mac Catalyst, WinUI, and Tizen"

Any other suggestions?

Note that the template without the sample app is still there too, so the description might be made a bit more accurate but let's make sure people know it's optional

jsuarezruiz · 2024-10-21T13:42:26Z

src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.es.json

+  "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
+  "symbols/IncludeSampleContent/displayName": "_Include sample content",
+  "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
+  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",


Will it be located later? only the main description seems to be localized.

@rmarinho I think a follow-up pr comes to localize, correct?

yap when is merged to main it will trigger the localization steps, we can then backport if we get the translations in time

src/Templates/src/templates/maui-mobile/Pages/MainPage.xaml

src/Templates/src/templates/maui-mobile/Pages/MainPage.xaml.cs

src/Templates/src/templates/maui-mobile/Resources/Styles/AppStyles.xaml

daltzctr · 2024-10-21T20:20:41Z

I notice no screenshots of Windows usage. Is Windows supported for this template or is it exclusively for mobile platforms?

davidortinau · 2024-10-21T23:03:48Z

I notice no screenshots of Windows usage. Is Windows supported for this template or is it exclusively for mobile platforms?

Windows is tested and supported. Someone could add some screenshots for completeness.

PaulAndersonS · 2024-10-22T03:51:35Z

I notice no screenshots of Windows usage. Is Windows supported for this template or is it exclusively for mobile platforms?

Windows is tested and supported. Someone could add some screenshots for completeness.

Added Windows screenshots

baaaaif · 2024-10-22T08:55:02Z

I am surprised that a SyncFusion Toolkit integration is being waved through so easily into the official template (even though it is free).

Don't other commercial providers such as DevExpress or Telerik feel offended by this?

I don't care, but I just wanted to point it out.

CliffAgius · 2024-10-22T09:22:23Z

Really like this but when it's in place can it be that the current empty template is the default and this new template that is awesome becomes an opt in or check box option.

Be nice if the template had some simple tests for testing the VM's and UI this seems to be where most projects struggle that I see in teams I help out with.

GeorgeLeithead · 2024-10-22T13:00:17Z

Really like this but when it's in place can it be that the current empty template is the default and this new template that is awesome becomes an opt in or check box option.

Be nice if the template had some simple tests for testing the VM's and UI this seems to be where most projects struggle that I see in teams I help out with.

I think it would be even better to have a check-box for each of the included toolkits, along with a '?' that links to the appropriate community landing page. For example,

Syncfusion Toolkit for .NET MAUI
.NET MAUI Community Toolkit
CommunityToolkit.Mvvm
SQLite

pictos

I like this new template, but I don't think it should be default one.

I also, have some suggestions

src/Templates/src/templates/maui-mobile/PageModels/ManageMetaPageModel.cs

src/Templates/src/templates/maui-mobile/PageModels/ProjectDetailPageModel.cs

src/Templates/src/templates/maui-mobile/PageModels/TaskDetailPageModel.cs

pictos · 2024-10-22T14:42:39Z

src/Templates/src/templates/maui-mobile/Pages/ProjectDetailPage.xaml.cs

+	}
+}
+
+public class ChipDataTemplateSelector : DataTemplateSelector


can this class have its own file?

Going to leave this one here for now we can discuss for the next iteration

pictos · 2024-10-22T14:44:57Z

src/Templates/src/templates/maui-mobile/Services/ModalErrorHandler.cs

+	/// <param name="ex">Exception.</param>
+	public void HandleError(Exception ex)
+	{
+		lock (this)


This isn't a good practice, if some one uses this ModalErrorHandler for locking it may cause a deadlock. And more important question, do we need a lock here? I don't think so, since the DisplayAlert will only run on UIThread

src/Templates/src/templates/maui-mobile/Pages/Controls/AddButton.xaml

davidortinau · 2024-10-22T15:14:25Z

I am surprised that a SyncFusion Toolkit integration is being waved through so easily into the official template (even though it is free).

Don't other commercial providers such as DevExpress or Telerik feel offended by this?

I don't care, but I just wanted to point it out.

We welcome all contributions, and there are various ways. This is just one of them.

More context for this PR: https://devblogs.microsoft.com/dotnet/dotnet-maui-welcomes-syncfusion-open-source-contributions/

davidortinau · 2024-10-22T15:17:55Z

I think it would be even better to have a check-box for each of the included toolkits, along with a '?' that links to the appropriate community landing page. For example,

Yeh, that's something we could do in the future. There are other VS extensions that provide this kind of experience today.

PureWeen · 2024-10-24T19:03:30Z

@pictos I tracked some of your comments here
#25515

Because I think they are useful to have a longer discussion about a few of these

akhanalcs · 2024-10-24T22:15:12Z

This is great, but don't make it the default one. Maybe something like:
dotnet new maui --sf and series of prompts to include additional options specific to Syncfusion.

PureWeen · 2024-10-24T22:34:42Z

This is great, but don't make it the default one. Maybe something like: dotnet new maui --sf and series of prompts to include additional options specific to Syncfusion.

It's not the default one anymore

Unless you're seeing something I missed?

PureWeen · 2024-10-25T00:34:40Z

https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=10449958&view=results
https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=10450238&view=results
https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=10450239&view=results
https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=10450241&view=results

### Description of Change This fixes the toggle for including sample content in the template. In #25419 some last-minute changes were made to not make the sample content show up by default, but that introduced a bug where you couldn't get the sample content to show up at all using Visual Studio. With this change the sample content can optionally be included again in Visual Studio by using the checkbox and through the CLI by specifying either `--sample-content` or `-sc`. Also the not used `Empty` switch was removed as well as the `SampleContent` variable which did not serve any additional purpose.

Added a new project template for .NET MAUI that integrates the Syncfu…

a1efa40

…sion Toolkit

PaulAndersonS requested a review from a team as a code owner October 21, 2024 13:12

PaulAndersonS requested review from Eilon and tj-devel709 and removed request for a team October 21, 2024 13:12

dotnet-policy-service bot added the community ✨ Community Contribution label Oct 21, 2024

jsuarezruiz added the area-templates Project templates, Item Templates for Blazor and MAUI label Oct 21, 2024

dotnet deleted a comment from jsuarezruiz Oct 21, 2024

dotnet deleted a comment from azure-pipelines bot Oct 21, 2024

jsuarezruiz reviewed Oct 21, 2024

View reviewed changes

PureWeen added this to the .NET 9.0 GA milestone Oct 21, 2024

baaaaif mentioned this pull request Oct 22, 2024

[gh actions] introduce "inclusive heat sensor" #25389

Merged

pictos reviewed Oct 22, 2024

View reviewed changes

PureWeen and others added 6 commits October 23, 2024 12:12

- change default and add template tests

cf43f8a

- update with latest changes

95d19c2

Update AppShell.xaml.cs

c7c8040

Update AppShell.xaml.cs

ce5a115

- fix

27be6a5

- fix

95b5af2

PureWeen and others added 4 commits October 23, 2024 14:37

- only add for SF template

fe5e40b

- fix InclueSampleContent

7954b2f

Update MauiApp.1.csproj

a751a8d

Update MauiApp.1.csproj

1ff892c

PureWeen mentioned this pull request Oct 24, 2024

[SF, Template] Additional discussions for the SF Template #25515

Open

PureWeen and others added 6 commits October 24, 2024 14:05

- updates

3fc2e07

- remove lock

4d6b87a

- slim

b8ae469

- fix

e15dcad

Update MauiApp.1.csproj

a61cc0b

- fix nowarn

6038ecd

Redth approved these changes Oct 24, 2024

View reviewed changes

Redth self-requested a review October 24, 2024 22:32

Redth approved these changes Oct 24, 2024

View reviewed changes

PureWeen merged commit bf4cafb into dotnet:release/9.0.1xx Oct 25, 2024
1 check passed

jfversluis mentioned this pull request Oct 28, 2024

Fix toggle for including sample content in template #25549

Merged

davidbritch mentioned this pull request Nov 13, 2024

.NET MAUI 9: Syncfusion Toolkit integration dotnet/docs-maui#2623

Closed

github-actions bot locked and limited conversation to collaborators Nov 24, 2024

sheiksyedm added the partner/syncfusion Issues / PR's with Syncfusion collaboration label Dec 10, 2024

samhouts added the fixed-in-9.0.0 label Dec 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add New .NET MAUI Template with Syncfusion Toolkit Integration #25419

Add New .NET MAUI Template with Syncfusion Toolkit Integration #25419

PaulAndersonS commented Oct 21, 2024 •

edited

Loading

dotnet-policy-service bot commented Oct 21, 2024

PaulAndersonS commented Oct 21, 2024

davidortinau commented Oct 21, 2024

jsuarezruiz left a comment

jsuarezruiz Oct 21, 2024

PaulAndersonS Oct 22, 2024

jfversluis Oct 22, 2024

jsuarezruiz Oct 21, 2024

jfversluis Oct 22, 2024

rmarinho Oct 22, 2024 •

edited

Loading

daltzctr commented Oct 21, 2024

davidortinau commented Oct 21, 2024

PaulAndersonS commented Oct 22, 2024

baaaaif commented Oct 22, 2024

CliffAgius commented Oct 22, 2024

GeorgeLeithead commented Oct 22, 2024

pictos left a comment

pictos Oct 22, 2024

PureWeen Oct 24, 2024

pictos Oct 22, 2024

davidortinau commented Oct 22, 2024

davidortinau commented Oct 22, 2024

PureWeen commented Oct 24, 2024

akhanalcs commented Oct 24, 2024

PureWeen commented Oct 24, 2024

PureWeen commented Oct 25, 2024

		@@ -3,7 +3,13 @@
		"name": ".NET MAUI App",
		"description": "A project for creating a .NET MAUI application for iOS, Android, Mac Catalyst, WinUI and Tizen",

Add New .NET MAUI Template with Syncfusion Toolkit Integration #25419

Add New .NET MAUI Template with Syncfusion Toolkit Integration #25419

Conversation

PaulAndersonS commented Oct 21, 2024 • edited Loading

dotnet-policy-service bot commented Oct 21, 2024

PaulAndersonS commented Oct 21, 2024

davidortinau commented Oct 21, 2024

jsuarezruiz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rmarinho Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

daltzctr commented Oct 21, 2024

davidortinau commented Oct 21, 2024

PaulAndersonS commented Oct 22, 2024

baaaaif commented Oct 22, 2024

CliffAgius commented Oct 22, 2024

GeorgeLeithead commented Oct 22, 2024

pictos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidortinau commented Oct 22, 2024

davidortinau commented Oct 22, 2024

PureWeen commented Oct 24, 2024

akhanalcs commented Oct 24, 2024

PureWeen commented Oct 24, 2024

PureWeen commented Oct 25, 2024

PaulAndersonS commented Oct 21, 2024 •

edited

Loading

rmarinho Oct 22, 2024 •

edited

Loading