Skip to content

Include JetBrains Rider support tab to Essential UI Kit for .NET MAUI Getting Started#4668

Open
Harsha-SF4223 wants to merge 3 commits into
developmentfrom
jetbrains-rider
Open

Include JetBrains Rider support tab to Essential UI Kit for .NET MAUI Getting Started#4668
Harsha-SF4223 wants to merge 3 commits into
developmentfrom
jetbrains-rider

Conversation

@Harsha-SF4223

Copy link
Copy Markdown
Contributor

Description

Enhanced the .NET MAUI User Guide documentation for Essential® UI Kit for .NET MAUI (GettingStarted) by adding JetBrains Rider support.

Files Updated

https://help.syncfusion.com/maui/essential-ui-kit/getting-started

Changes Made

Added

  • Added a new JetBrains Rider tab section ({% tabcontent JetBrains Rider %} … {% endtabcontent %}) to the existing {% tabcontents %} block, placed after the Visual Studio Code tab.
  • Added step-by-step instructions for verifying the JetBrains Rider plugin installation via Settings > Plugins > Installed, with a link to the download-and-installation guide.
  • Added steps for opening a .NET MAUI project, accessing the Tools → Essential UI Kit for .NET MAUI context menu, navigating the category wizard, naming pages, and adding them with the necessary View, ViewModel, Model classes, resources, and NuGet package references.
  • Added image references for the workflow: UI-Kit-images/Menu.png, UI-Kit-images/Maui-Wizard.png, UI-Kit-images/Edit-Wizard.png, UI-Kit-images/ViewFiles.png, UI-Kit-images/Resources.png, and UI-Kit-images/Packages.png.
  • Added a Syncfusion® licensing registration note referencing the 2018 Volume 2 (v16.2.0.41) Essential Studio® release, with a link to the Syncfusion licensing overview.

Updated

  • Aligned the JetBrains Rider tab content format with the existing Visual Studio and Visual Studio Code tabs (numbered steps, bold UI labels, image references).
  • Maintained consistency with the tab-block structure used across the documentation (as seen in Cartesian-Charts/Getting-Started.md).

Fixed

  • N/A (no fixes—additive change only).

Why This Change?

  • Enable JetBrains Rider users to integrate the Essential® UI Kit for .NET MAUI templates within the documentation itself, rather than relying solely on an external guide.
  • Provide IDE parity with the existing Visual Studio and Visual Studio Code tabs.
  • Improve developer onboarding for JetBrains Rider users adopting .NET MAUI.
  • Ensure the documentation covers all supported IDEs consistently.

Validation

  • Verified documentation flow
  • Verified tab-block structure ({% tabcontents %} / {% tabcontent %} / {% endtabcontent %} / {% endtabcontents %})
  • Verified image path references (consistent with existing UI-Kit-images/ folder)
  • Reviewed grammar and readability
  • Checked for errors after edits

Impact

  • No API changes.
  • No functional changes.
  • Documentation enhancement only.

Documentation Enhancement Metrics

Category Count
New Tab Added 1
New Steps Added 7
New Images Referenced 6
Licensing Notes Added 1
Files Modified 1

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: jetbrains-rider

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: jetbrains-rider
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@sfHariHaraSudhan sfHariHaraSudhan left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Enhanced the jetbrains content by adding all the missing details too. Replace this.

`{% tabcontent JetBrains Rider %}

Prerequisites

  • JetBrains Rider 2024.2 or later is required.
  • Ensure the .NET MAUI workload (.NET 8 and later) is installed before proceeding.
  • Ensure the Essential® UI Kit for .NET MAUI - Syncfusion® plugin is installed in JetBrains Rider. To check, go to Settings > Plugins > Installed. If the plugin is not installed, follow the steps below:
    1. Open JetBrains Rider.
    2. Navigate to File > Settings > Plugins.
    3. Select the Marketplace tab, type Essential® UI Kit for .NET MAUI in the search field, and click Install.
    4. Restart JetBrains Rider if prompted.

Add UI Kit templates to a .NET MAUI project

  1. Open JetBrains Rider and open an existing .NET MAUI project, or create a new MAUI app first.

  2. In the Solution Explorer, right-click the project and choose Tools → Essential UI Kit for .NET MAUI - Syncfusion® as shown in the following screenshot.

    Syncfusion Essential UI Kit for .NET MAUI Context menu in MAUI

  3. The category dialog wizard will open with pre-defined templates.

    Add new item dialog box

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

  5. 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

  6. The selected pages will be added along with the View, ViewModel, Model classes, resource files, and the Syncfusion® NuGet package reference as shown in the following screenshots.

    Added files in MAUI Project

    Added Resources in MAUI Project

    Added NuGet in MAUI Project

  7. To set the new page as the startup page, see the How to Render the Added Page? section below.

Troubleshooting

  • Templates don't appear: Restart Rider after installing the plugin, or verify the plugin is enabled under Settings > Plugins > Installed.
  • NuGet packages failing to restore: Ensure your NuGet sources are available and the project targets a supported MAUI framework (.NET 8 and later).

N> Syncfusion® licensing registration is required if you have installed the trial setup or NuGet packages, since Syncfusion® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio® release. When a page is added, a licensing message box will appear with a link to register the key. Refer to the Syncfusion licensing overview to generate and register the license key in your project. Refer to this blog post for details on the licensing changes introduced in Essential Studio®.

{% endtabcontent %}
{% endtabcontents %}`

@sfHariHaraSudhan sfHariHaraSudhan left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved.

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: jetbrains-rider

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: jetbrains-rider

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: jetbrains-rider
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: jetbrains-rider

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: jetbrains-rider
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@sfHariHaraSudhan sfHariHaraSudhan left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants