Convert to Telerik Application

This article demonstrates how to enable the Progress® Telerik® UI for Blazor components in your existing Blazor app with a few mouse clicks. This can be helpful if you already have a substantial app, or you want to use the Microsoft templates to start with features like authentication and add UI components later.

To add the Telerik Components to your existing Blazor application, use the Convert Project wizard. The wizard detects all installed versions of Telerik UI for Blazor and lists them in the Version combobox—this enables you to start your project with the desired version. You can also get the latest version to make sure you are up to date.

The wizard automates several steps for you that you otherwise must perform manually:

• Adding the client assets to your project:

  • Adding the Telerik stylesheet.
  • Adding the JS Interop file.

• Configuring the project to use the Telerik UI for Blazor components:

  • Adding the required @using directives to the ~/_Imports.razor file.
  • Adding the TelerikLayout.razor component at the root level of the DOM.
  • Registering the Telerik services for client-side projects and for server-side projects.

Get the Wizard

To use the Convert Project wizard, install the Telerik UI for Blazor Visual Studio Extensions. You can get the extension from:

• The Visual Studio Marketplace (for Visual Studio 2022 for Windows and Visual Studio 2019 for Windows).
• The Telerik UI for Blazor automated installer (for Windows and Mac).
• Your Telerik.com account - the .mpack file for VS for Mac.

Start the Wizard

You have two options to start the wizard:

• The Project Context Menu
• The VS Extensions Menu

Project Context Menu

1. In the Solution Explorer, select the Blazor app where you want to add the Telerik components (either WebAssembly, or Server-side Blazor).
2. Right click the project node, and then select Telerik UI for Blazor > Convert to Telerik Application.
3. Follow the wizard.

Start the Convert Wizard from the project context menu

Extensions Menu

Alternatively, instead of the context menu, you can use the Visual Studio extensions menu at the top:

1. In the Solution Explorer, select the Blazor app where you want to add the Telerik components (either WebAssembly, or Server-side Blazor).
2. Open the Extensions menu.
3. Click Telerik > Telerik UI for Blazor > Convert to Telerik Application.
4. Follow the wizard.

Start the wizard from the Extensions menu

Features

The wizard provides you with the following options:

1. The ability to download the latest available version.
2. A version selector so you can choose a particular version to add to the project.
3. A list with the versions found on your machine that you can choose from.
4. Whether to back up the project state before the conversion (in a folder called <ProjectName>_Backup>_<timestamp>).

The Convert Project Wizard Options

The wizard automates several steps for you that you can also perform manually. To get a better understanding of what the wizard does for you, see either of the following articles (they provide the same information in different formats):

Troubleshooting

There are three common problems when converting a project:

• The conversion wizard fails with an error screen.
• The Telerik components do not work after you run the converted project.
• An extra shared folder appears.

Error Screen

If you see an error screen similar to the one below, make sure that the actual Blazor application is selected in the Solution Explorer. This is most common with WebAssembly types of applications as they consist of a Server and Shared projects by default, and only the Client project is the actual Blazor app that needs the Telerik components.

Some specific project settings can also cause an exception during conversion. The fastest solution is to configure the project for the Telerik components manually.

Error screen when the project can't be converted

Components Fail

The issue can manifest in a couple of ways:

• The components have no styling.
• There are JavaScript errors that Telerik objects cannot be found.

The most common reason for this problem is a mismatch between the installed version and the actual license that you have. For example:

• Only a trial version is installed on your development machine, but you already have a commercial license, yet you never installed the commercial version.
• The wizard did not properly detect the installed version.

The cause are wrong paths to the needed web assets. To resolve this open the index file:

• wwwroot/index.html for a WebAssembly Blazor app
• ~/Pages/_Host.cshtml for a Server-Side Blazor app using .NET 3.x or .NET 5
• ~/Pages/_Layout.cshtml for a Server-Side Blazor app using.NET 6

Look for the comments left by the wizard. The comments are in the <head> near the Telerik assets and show the correct paths for a trial and commercial license.

Extra Shared Folder

You may get a Shared folder that contains a TelerikLayout.razor file at an unexpected place in the project. This can happen if a folder in the project was selected instead of the project itself when running the convert wizard.

The fix is to move the TelerikLayout.razor file to the original Shared folder of your project, next to the MainLayout.razor file.

See Also

• Visual Studio Extensions Overview
• Downloading the Latest Telerik UI for Blazor Versions
• Getting Started with Client-side apps
• Getting Started with Server-side apps
• Workflow for Using the UI Components for Blazor