Telerik Blazor Project and Item Templates

This repository provides Visual Studio templates for Telerik Blazor apps with some convenient extras.

When installed, the templates can be used to create new Blazor apps in Visual Studio or with dotnet new CLI commands.

• Install
• Use with Visual Studio
• Use with the .NET CLI
• Extras
• Update or Uninstall
• License

Install

1. Close Visual Studio.
2. Download the NuGet package from the latest release to some folder.
3. Open your Terminal or Shell app and go to the folder from the previous step.
4. Execute the dotnet new install command:

   dotnet new install Dimodi.Telerik.Blazor.Templates.*.nupkg

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.

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

Use with the .NET CLI

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

dotnet new tbgridedit --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 tbserver6 -o MyNewAppName

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

.NET 8 Interactivity

The .NET 8 Server template (tbserver8) sets global Server interactivity.

The .NET 8 WebAssembly template (tbwasm8) sets global WebAssembly interactivity. To create a project with Auto interactivity, set rendermode to Auto in the dotnet new command:

dotnet new tbwasm8 -o MyNewAppName --rendermode Auto

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 tbgrid -n MyNewGridPаge

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

Extras

The item templates provide declarations of Telerik Blazor components together with dummy data, which includes different data types.

The project templates are similar to the default .NET SDK Blazor project templates. The differences are:

• The apps reference the latest Telerik UI for Blazor version. The WebAssembly standalone apps reference the latest minor .NET version.
• The Telerik UI for Blazor NuGet package, namespaces, service, and static assets are added, according to best practices.
• You can configure some settings related to the Telerik UI for Blazor components during app creation (see the default values in the brackets):
  • Theme (Default)
  • Icon type (SVG icons or Font icons) (SVG)
  • CDN support (disabled)
  • RTL support (disabled)
• The Telerik CSS and JS files are loaded with a query string cache buster to prevent browser caching across version upgrades.
• Program.cs contains commented code to increase the maximum file upload size.
• Program.cs in server apps contains commented code to increase the maximum SignalR message size.
• The SurveyPrompt Razor component is removed.
• The <button> and <table> HTML elements in the default sample pages are replaced with Telerik Button and Grid.

Update or Uninstall

1. Remove the currently installed package:

   dotnet new uninstall Dimodi.Telerik.Blazor.Templates

2. Repeat the installation steps.

License

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

The project templates are subject to MIT License.