Dimodi.Telerik.Blazor.Templates 4.0.0

Telerik Blazor Project and Item Templates

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

• Templates
• Install
• Use with Visual Studio
• Use with the .NET CLI
• Extras
• Update
• Uninstall
• 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 row selection, grouping, and two data binding mechanisms
• Editable Grid with CRUD operations

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.

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-gridedit --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 the latest Telerik UI for Blazor version. 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 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. This feature is missing from the WebAssembly Standalone App template due to dynamic content usage restrictions in index.html.
• 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.
• .NET 8+ apps use the https launch profile by default.
• 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

Update From nuget.org

Execute the dotnet new update command:

dotnet new update Dimodi.Telerik.Blazor.Templates

Update from GitHub

1. Remove the currently installed package:

   dotnet new uninstall Dimodi.Telerik.Blazor.Templates
   

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

License

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

The project templates are subject to MIT License.