Microsoft Templates

  • 3 minutes to read
IMPORTANT

Ensure your system meets these requirements.

This topic describes how to:

NOTE

These instructions are also available in the following videos:

1. Create a New Project

The steps below describe how to create a new Blazor project. If you want to add DevExpress Blazor components to an existing application, go to Step 2.

  1. Click Create a new project on Visual Studio's start page, select the Blazor App template, and click Next.

    GettingStarted Create a New Project

  2. Specify the project name and location, and click Create.

    GettingStarted Configure a New Project

  3. Select a template and click Create.

2. Obtain Your DevExpress NuGet Feed

You need to obtain your personal NuGet feed URL to access the DevExpress.Blazor NuGet package from your project.

  1. Make sure your DevExpress.com account has access to Blazor UI Components. This product line is available as part of the Universal, DXperience, or ASP.NET subscription. Refer to the subscription comparison matrix for more information.

  2. Use your DevExpress credentials to log into nuget.devexpress.com.

  3. Obtain your NuGet feed URL and copy it to the clipboard.

    NuGet Feed

    You can find the same URL in the Download Manager.

3. Install the DevExpress Blazor NuGet Package

  1. In Visual Studio, select Tools -> NuGet Package Manager -> Package Manager Settings.

    GettingStarted Package Manager Settings

  2. Navigate to NuGet Package Manager -> Package Sources. Click the plus sign at the top right corner to add a new NuGet package source. Use the following package settings:

    • Name - DevExpress

    • Source - the obtained NuGet Feed URL (https://nuget.devexpress.com/{your feed authorization key}/api)

    Click OK.

    GettingStarted NuGet Feed API

    NOTE

    Make sure the nuget.org package source is also enabled.

  3. Select Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution.

  4. In the invoked dialog, open the Browse tab, select the created DevExpress package source, and install the DevExpress.Blazor NuGet package.

    GettingStarted Install Package

  5. Build the project.

4. Register DevExpress Resources

Blazor Server

  1. Add the following line to the Pages/_Host.cshtml file's HEAD section:

    <head>
        <!--...-->
        <link href="_content/DevExpress.Blazor/dx-blazor.css" rel="stylesheet" />
    </head>
    
  2. Register the DevExpress.Blazor namespace in the _Imports.razor file:

    @using DevExpress.Blazor
    

Blazor WebAssembly

  1. Add the following line to the wwwroot/index.html file's HEAD section:

    <head>
        <!--...-->
        <link href="_content/DevExpress.Blazor/dx-blazor.css" rel="stylesheet" />
    </head>
    
  2. Call the AddDevExpressBlazor(IServiceCollection, Action<GlobalOptions>) method from your project's Program.Main() method:

    using Microsoft.Extensions.DependencyInjection;
    
    public class Program {
        public static async Task Main(string[] args) {
            var builder = WebAssemblyHostBuilder.CreateDefault(args);
            // ...
            builder.Services.AddDevExpressBlazor();
            await builder.Build().RunAsync();
        }
    }
    
  3. Register the DevExpress.Blazor namespace in the _Imports.razor file:

    @using DevExpress.Blazor
    
  4. Configure the linker as described in Configure the Linker for ASP.NET Core Blazor.

    NOTE

    If you enabled the ASP.NET Core hosted option when you create the project, make sure that the server-side project is set as the solution's startup project.

5. Add DevExpress Blazor Components

For instructions on how to add an individual DevExpress Blazor component to your application, refer to the documents below: