Dimodi.Telerik.Blazor.Templates 5.3.1

Telerik UI for Blazor Project and Item Templates

This NuGet package provides ASP.NET Core Blazor project and item templates that include the Telerik UI for Blazor component library. The project templates provide multiple settings to configure the Telerik Blazor components during app creation. The item templates expose settings to enable various Telerik component features.

Table of Contents

• Templates
  • Project Templates
  • Deprecated Project Templates
  • Item Templates
• Install
• Use with Visual Studio
• Use with VS Code
• Use with the .NET CLI
  • Create Projects
  • Create Items
• Project template features
  • Telerik UI for Blazor Configuration
  • Docker Support
• Update
• Uninstall
• Create your own templates
• License

Templates

The package includes the following project and item templates.

Project Templates

Deprecated Project Templates

The following project templates are deprecated and do not include the latest template features:

• The two Web App project templates (Server and WebAssembly/Auto) have a new single alternative: Telerik Blazor Web App.
• The two .NET 6-7 project templates are compatible with Telerik UI for Blazor version 8.x, but are not compatible with version 9.x.

Item Templates

The item templates produce a runnable .razor file that includes a Telerik Blazor component, dummy data, and applicable event handlers.

Install

1. Close Visual Studio.
2. Open your Terminal or Shell app.
3. Execute the dotnet new install command:

   dotnet new install Dimodi.Telerik.Blazor.Templates
   

Use with Visual Studio

On Windows, the new project templates will appear in the C#, Web and Blazor categories in the Create New Project wizard. Make sure to select "All platforms" in the respective dropdown.

On Mac, the new project templates will appear in the Other > Custom category. Visual Studio for Mac is unable to run .NET 8 Blazor Web Apps with WebAssembly or Auto render mode if .NET 9 is installed. In this case, edit and run the app through VS Code or another compatible IDE.

When creating a WebAssembly app, make sure to select the server project as a startup project before running.

To create a new .razor file from an item template, use the .NET CLI.

Use with VS Code

Install the C# Dev Kit extension.

To create a new app:

1. Go to the Command Palette at the top (Ctrl + Shift + P).
2. Select Show and Run Commands.
3. Select .NET: New Project...
4. Type a project name and configure the project template options.

To create a new .razor file from an item template, use the .NET CLI.

Use with the .NET CLI

To see all available project and item templates, execute the dotnet new list command with the --author option:

dotnet new list --author="Dimo Dimov"

For help on a specific project or item template, execute the dotnet new command with the --help option, for example:

dotnet new dimodi-grid --help

Create Projects

1. Open Terminal and go to the desired parent folder of your future app.
2. Execute the dotnet new command with the short name of the template and the app name, for example:

   dotnet new dimodi-blazor -o MyNewAppName
   

Create Items

1. Open Terminal and go to a folder inside your existing app, for example Pages or Components.
2. Execute the dotnet new command with the short name of the template and the file name, for example:

   dotnet new dimodi-grid -n MyNewGridPаge
   

3. The above command will produce a MyNewGridPаge.razor file inside the current folder.

Project Template Features

The project templates are similar to the default .NET SDK Blazor project templates in terms of structure and configuration. The differences are:

• The Blazor Web Apps use a Global interactivity location, i.e. interactive render mode for the entire app. This is the easier and recommended way to integrate Telerik UI for Blazor.
• The WebAssembly apps reference the latest minor version of the selected .NET version through a wildcard.
• The apps use the https launch profile by default.
• Visual Studio opens Home.razor automatically after the app is created.
• The top bar uses background and border colors from the Telerik theme. This makes the styling consistent in dark mode.
• The <button> and <table> HTML elements in the default sample pages are replaced with Telerik Button and Grid.
• The SurveyPrompt Razor component is removed.

Telerik UI for Blazor Configuration

• The Telerik UI for Blazor NuGet package, namespaces, service, and static assets are added, according to best practices. The query string cache buster for the Telerik CSS and JavaScript files is missing from the WebAssembly Standalone App template due to dynamic content restrictions in index.html.
• The Web App templates set PrivateAssets="none" to the Telerik UI for Blazor NuGet package reference when using WebAssembly or Auto render mode. This avoids license warnings on app startup.

The project templates provide options to configure the app and the Telerik UI for Blazor components during app creation:

Docker Support

The project templates provide an optional Docker setup, including Dockerfile, .dockerignore, and a Docker launch profile. The Dockerfile sets up the Telerik NuGet package source in the container.

The Dockerfile contains additional documentation and tips.

Update

Execute the dotnet new update command:

dotnet new update Dimodi.Telerik.Blazor.Templates

Uninstall

To remove the currently installed package, execute the dotnet new uninstall command:

dotnet new uninstall Dimodi.Telerik.Blazor.Templates

Create Your Own Templates

If you wish to experiment with your own project or item templates, then start from here:

• https://learn.microsoft.com/en-us/dotnet/core/tools/custom-templates
• https://github.com/dotnet/templating/
• https://github.com/dotnet/aspnetcore/tree/main/src/ProjectTemplates
• https://github.com/sayedihashimi/template-sample

Prepare for reading incomplete and unofficial documentation, and achieving your goals by trial and error.

License

Telerik UI for Blazor is a commercial component library with its own license agreement.

The project and item templates are subject to MIT License.