Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
61 changes: 61 additions & 0 deletions Extension/NETMAUI-Extension/JetBrains/Essential-UI-Kit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
layout: post
title: Getting Started | Essential® UI Kit for .NET MAUI Plugin | Syncfusion
description: How to add and use the Essential® UI Kit for .NET MAUI Syncfusion templates in your .NET MAUI project (JetBrains Rider guidance).
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Essential® UI Kit for .NET MAUI

This guide explains how to integrate Syncfusion® MAUI UI Kit templates into a .NET MAUI project using JetBrains Rider, providing ready-to-use XAML pages along with corresponding View and ViewModel classes, resource files, and all necessary Syncfusion® NuGet package references.

N> Before using the **Essential® UI Kit for .NET MAUI - Syncfusion<sup>®</sup>**, ensure that the plugin is installed in JetBrains Rider. To check, go to **Settings > Plugin >Installed** . If the plugin is not installed, follow the steps in the [download and installation](download-and-installation) help guide to install it.

**Add UI Kit templates to a .NET MAUI project**

1. Open your .NET MAUI project in Rider and right‑click the project and choose `Tools` → `Essential UI Kit for .NET MAUI`.

![Syncfusion Essential UI Kit for .NET MAUI Context menu in MAUI](images/Menu.png)

2. The category dialogue wizard will open with pre-defined templates.

![Add new item dialog box](images/Maui-Wizard.png)

3. Choose one or more page templates (for example, `About Us Page With Cards`), then click `Next`.

4. Enter a name for the new page and click `Add` to scaffold the XAML page, View, ViewModel, model classes, and resources.

![Edit page Name in MAUI UI Kit Plugin](images/Edit-Wizard.png)

5. The selected pages will be added along with View, View Model, Model classes, resource files and Syncfusion® NuGet package reference.

![Added files in MAUI Project](images/ViewFiles.png)

![Added Resources in MAUI Project](images/Resources.png)

![Added NuGet in MAUI Project](images/Packages.png)

6. Syncfusion® licensing registration required message box will be shown if you installed the trial setup or NuGet packages since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. Navigate to the [help topic](https://help.syncfusion.com/common/essential-studio/licensing/overview#how-to-generate-syncfusion-license-key), which is shown in the licensing message box to generate and register the Syncfusion® license key to your project. Refer to this [blog](https://www.syncfusion.com/blogs/post/whats-new-in-2018-volume-2.aspx) post for understanding the licensing changes introduced in Essential Studio®.

**Set the new page as the app start page**

Open `App.xaml.cs` and update `CreateWindow` to return your new page. Example — if you added `LoginWithSocialIcon`:

```csharp
protected override Window CreateWindow(IActivationState? activationState)
{
return new Window(new LoginWithSocialIcon());
}
```

**Troubleshooting**

- Templates don’t appear: restart Rider after installing the extension or verify the plugin is enabled.

- NuGet packages failing to restore: ensure your NuGet sources are available and that the project targets a supported MAUI framework.

- License prompts persist: confirm the license key is registered early in app startup and matches your Syncfusion account.


49 changes: 49 additions & 0 deletions Extension/NETMAUI-Extension/JetBrains/download-and-installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: post
title: Download and Installation | Essential® UI Kit | Syncfusion
description: How to download the Essential® UI Kit for .NET MAUI Plugin from the JetBrains marketplace site and from the plugins View tab.
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Download and Setup - Essential® UI Kit for .NET MAUI Kit Plugin

Syncfusion® publishes the Essential® UI Kit for .NET MAUI Plugin in [JetBrains marketplace](https://plugins.jetbrains.com/plugin/28456-document-viewer). You can either install it from JetBrains Rider or download and install it from the JetBrains marketplace.

## Prerequisites

Before getting started, make sure your environment meets the following requirements:

* A JetBrains IDE - Rider

> The minimum version of the JetBrains IDE is 2024.2 to use the Essential® UI Kit for .NET MAUI Kit plugin.


## Install through the JetBrains Rider

The following steps explain how to install the Essential® UI Kit for .NET MAUI plugin from JetBrains Rider.

1. Open JetBrains Rider.

2. Navigate to **File > Settings > Plugins**.

3. Select the **Marketplace** tab and type **Essential® UI Kit for .NET MAUI** in the search field, Click the Install button on the plugin.

![Installing Essential UI Kit for .NET MAUI Plugin](images/Installation.png)

4. After the installation completes, restart your JetBrains Rider if prompted.

## Install plugin from disk

The following steps explain how to install the Essential® UI Kit for .NET MAUI Kit plugins from JetBrains Rider from the disk.

1. Download the plugin archive (ZIP or JAR) of [Essential® UI Kit for .NET MAUI](https://plugins.jetbrains.com/plugin/28456-document-viewer).

2. Press `Ctrl` + `Alt` + `S` to open settings and then select Plugins.

3. On the Plugins page, click The Settings button and then click Install Plugin from Disk.

4. Select the plugin archive file and click OK.

5. Click OK to apply the changes and restart the IDE if prompted.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions Extension/NETMAUI-Extension/JetBrains/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: post
title: Essential® UI Kit for .NET MAUI Plugin | Extension | Syncfusion
description: The Essential® UI Kit for .NET MAUI Plugin enables you to easily add templates for quickly building customizable cross-platform user interfaces in .NET MAUI.
platform: extension
control: Syncfusion Extensions
documentation: ug
---

# Essential® UI Kit for .NET MAUI Plugin - JetBrains Rider

## Overview

The **Essential® UI Kit for .NET MAUI** offers a collection of ready-to-use XAML templates that help developers quickly build modern, cross-platform user interfaces. It follows a structured architecture with clear separation of View, ViewModel, and Model layers, making it easier to implement business logic and customize existing UI designs. The UI Kit also requires the integration of Syncfusion® NuGet packages for full functionality.
16 changes: 15 additions & 1 deletion extension-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@
<ul>
<li><a href="/extension/netmaui-extension/visual-studio/overview">Overview</a></li>
<li><a href="/extension/netmaui-extension/visual-studio/download-and-installation">Download and Installation</a></li>
<li><a href="/extension/netmaui-extension/visual-studio/Essential-UI-Kit">Download and Installation</a></li>
<li><a href="/extension/netmaui-extension/visual-studio/Essential-UI-Kit">Essential® UI Kit</a></li>
<li><a href="/extension/netmaui-extension/visual-studio/template-studio">Template Studio</a></li>
<li><a href="/extension/netmaui-extension/visual-studio/Toolbox-Control">Toolbox Control</a></li>
<li><a href="/extension/netmaui-extension/visual-studio/Syncfusion-Notifications">Notifications</a></li>
Expand All @@ -427,6 +427,20 @@
<li><a href="/extension/netmaui-extension/visual-studio-code/Essential-UI-Kit">Essential® UI Kit</a></li>
</ul>
</li>
<li>
JetBrains
<ul>
<li>
<a href="/extension/netmaui-extension/jetbrains/overview">Overview</a>
</li>
<li>
<a href="/extension/netmaui-extension/jetbrains/download-and-installation">Download and Installation</a>
</li>
<li>
<a href="/extension/netmaui-extension/jetbrains/Essential-UI-Kit">Essential® UI Kit</a>
</li>
</ul>
</li>
</ul>
</li>

Expand Down