Dimodi.Telerik.Blazor.Templates 5.0.0

Telerik Blazor Project and Item Templates

This NuGet package provides Visual Studio project and item templates for Telerik Blazor apps and component scaffolders with some convenient extras.

Table of Contents

• Templates
• Install
• Use with Visual Studio
• Use with the .NET CLI
• Extras
• Update
• Uninstall
• Create your own templates
• License

Templates

• .NET 8-9 Blazor Web App with global interactive Server render mode
• .NET 8-9 Blazor Web App with global interactive WebAssembly or Auto render mode
• .NET 8-9 Blazor WebAssembly Standalone App
• .NET 6-7 Blazor Server App
• .NET 6-7 Blazor WebAssembly App (ASP.NET Core hosted)
• Grid with optional CRUD operations, row selection, grouping, and two data binding mechanisms
• TreeView with optional selection, checkboxes, and flat or hierarchical data structure

Install

Install From nuget.org

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
   

Install From GitHub

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. 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, you can edit the app code in Visual Studio, but run the app through the .NET CLI. Or, edit and run the app through VS Code.

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

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"

The project templates use similar short names to the respective Microsoft counterparts, but with a dimodi prefix and sometimes a suffix, for example:

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-server -o MyNewAppName
   

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

Interactive Render Mode

The Blazor Web App (Server) template (dimodi-blazor-server) sets global Server interactivity location.

The Blazor Web App (WebAssembly / Auto) template (dimodi-blazor-wasmauto) sets global WebAssembly or Auto interactivity. To create a project with Auto interactivity, set rendermode to Auto in the dotnet new command:

dotnet new dimodi-blazor-wasmauto -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 dimodi-grid -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 one of the latest Telerik UI for Blazor versions or the latest version as a wildcard *.
• The WebAssembly 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 app and the Telerik UI for Blazor components during app creation (see the default values in the brackets):
  • Theme (Default)
  • Dark theme swatch (disabled). Requires CDN.
  • Icon type (SVG icons or Font icons) (SVG)
  • CDN support (disabled). WebAssembly Standalone Apps support CDN only with a fixed Telerik UI for Blazor version number. Blazor Web Apps support CDN with both fixed and wildcard (*) version.
  • Localization in .NET 8 and .NET 9 apps (disabled)
  • RTL support (disabled)
  • Maximum file upload size (128 MB in FormOptions and 28 MB in Kestrel) *
  • Maximum SignalR message size (32 KB) *
• The Telerik CSS and JS files are loaded with a query string cache buster to prevent browser caching across version upgrades. This feature is missing from the WebAssembly Standalone App template due to dynamic content usage restrictions in index.html.
• .NET 8 and .NET 9 apps use the https launch profile by default.
• The top bar uses background and border colors from the Telerik theme. This makes the styling consistent in dark mode.
• The SurveyPrompt Razor component is removed.
• The <button> and <table> HTML elements in the default sample pages are replaced with Telerik Button and Grid.

* The options to change the max file upload size and the max SignalR message size work in Visual Studio on Windows and through the .NET CLI. They don't appear in VS Code and in Visual Studio for Mac. In these cases, edit Program.cs after creating the app.

Update

Update From nuget.org

Execute the dotnet new update command:

dotnet new update Dimodi.Telerik.Blazor.Templates

Update from GitHub

1. Uninstall the package.
2. Repeat the GitHub installation steps.

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 a lot of 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.