DevExpress UI for Blazor

DevExpress UI for Blazor ships with over 15 UI components (including a Data Grid, Pivot Grid, Scheduler and Charts) so you can design rich user experiences for both Blazor server-side and Blazor client-side platforms.

The DevExpress UI components are available for free download and can be used in your next Blazor app.

• Live Demo
• Examples
• Documentation
• Blog
• Version Compatibility
• Set Up Your Environment
• How to Run This Demo Locally
• How to Create a New Project
• Themes
• Localization
• Free Blazor Utilities and Dev Tools
• Troubleshooting
• Included Demo Modules
• NuGet Package Change Log

Online Demos

Check out the DevExpress UI Components for Blazor's online demos here.

Code Examples

DevExpress Blazor components are shipped with GitHub feature-based examples. Refer to examples.md for more information.

Documentation

Our online documentation is available at docs.devexpress.com/Blazor/.

Blog

Read about the latest updates to the DevExpress Blazor UI components on our blog.

Version Compatibility

The following table describes the version compatibility of .NET Core and the DevExpress.Blazor NuGet package:

Supported frameworks	DevExpress.Blazor.nuget version
.NET Core 3.1.2 Release Blazor WebAssembly 3.2.0 Preview 1	19.2.4-Release
.NET Core 3.1.1 Release Blazor WebAssembly 3.2.0 Preview 1	19.2.3 Release
.NET Core 3.1.1 Release	19.2.2 Beta (make sure the Include prerelease option is enabled)
.NET Core 3.1 Release	19.2.1 Beta (make sure the Include prerelease option is enabled)
.NET Core 3.1 Release	19.1.10 Release
.NET Core 3.0 Release	19.1.9 Release
.NET Core 3.0 Release	19.1.8 Release
.NET Core 3.0 Release	19.1.7 Release

Starting with v19.1.7, DevExpress UI components for Blazor are distributed through a personal NuGet feed. Register at devexpress.com to subscribe to the feed.

Set Up Your Environment

1. Install the latest Visual Studio 2019 update with the ASP.NET and web development workload.
2. Ensure that you have the latest .NET Core 3 version (from supported versions listed above) installed.

How to Run This Demo Locally

The Blazor framework uses either WebAssembly-based .NET runtime (Blazor WebAssembly) or server-side ASP.NET Core (Blazor Server). Our Blazor components support both of these approaches.

You can find appropriate demos in the repositories below:

• demo/BlazorDemo.ServerSide
• demo/BlazorDemo.ClientSide
• demo/BlazorDemo.ClientSideWithPrerendering*

* For more information, see the Update Metadata at Runtime - Free SEO Tool blog post. Make sure that you run this demo correctly.

To open the required demo, do the following:

1. Download the "demo" and tools folders from the proper repository.

2. Use Visual Studio 2019 to open the solution file:

   demo/BlazorDemo.ServerSide/BlazorDemo.ServerSide.sln

   or

   demo/BlazorDemo.ClientSide/BlazorDemo.ClientSide.sln

   or

   demo/BlazorDemo.ClientSideWithPrerendering/BlazorDemo.ClientSideWithPrerendering.sln

3. Go to nuget.devexpress.com, log in as a registered DevExpress customer and click Obtain Feed URL. The subsequent page displays a development account's NuGet Feed URL.

   Open the "Package Manager Settings".

   

   Add new NuGet source:

   https://nuget.devexpress.com/{your feed authorization key}/api

   

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

4. Install the "DevExpress.Blazor" NuGet package.

   Navigate to:

   

   Install the "DevExpress.Blazor" NuGet package.

   To install the latest Release package version, clear the Include prereleases checkbox. To test a Beta version of the "DevExpress.Blazor" NuGet package, make sure that the Include prerelease option is enabled.

   

5. Start the application.

For the ClientSideWithPrerendering demo, make sure that the ServerSide project is set as the solution's startup project.

See also:

Official Microsoft Blazor site

How to Create a New Project

Follow the steps below to try our UI for Blazor in your own application.

1. In the "Create a new project" dialog select "Blazor App".

In the next step select a project template.

2. Go to nuget.devexpress.com, log in as a registered DevExpress customer and click Obtain Feed URL. The subsequent page displays a development account's NuGet Feed URL.

   Open the "Package Manager Settings".

   

   Add new NuGet source:

   https://nuget.devexpress.com/{your feed authorization key}/api

   

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

3. Install the "DevExpress.Blazor" NuGet package.

   Navigate to:

   

   Install the "DevExpress.Blazor" NuGet package.

   To install the latest Release package version, clear the Include prereleases checkbox. To test a Beta version of the "DevExpress.Blazor" NuGet package, make sure that the Include prerelease option is enabled.

   

4. Build the project.

5. Link the following file to your layout's HEAD section:

   • For Blazor Server, add the line below to the Pages/_Host.cshtml file.

     <head>
         ...
         <link href="_content/DevExpress.Blazor/dx-blazor.css" rel="stylesheet" />
     </head>

   • For Blazor WebAssembly, add the line below to the wwwroot/index.html file.

     <head>
         ...
         <link href="_content/DevExpress.Blazor/dx-blazor.css" rel="stylesheet" />
     </head>

     Call the AddDevExpressBlazor method from your project's Program.Main() method:

     using Microsoft.Extensions.DependencyInjection;
     
     public class Program {
       public static async Task Main(string[] args) {
         ...
         builder.Services.AddDevExpressBlazor();
         await builder.Build().RunAsync();
       }
     }

6. Register DevExpress.Blazor namespace in _Imports.razor file:

   @using DevExpress.Blazor

7. Your application is ready to use DevExpress Blazor.

Themes

DevExpress Blazor components use the client-side Bootstrap framework to render their user interface. You can apply a Bootstrap-based theme to a Blazor application to change the appearance of all the components. Refer to the Themes help topic for more information.

Localization

DevExpress Blazor components ship localizable resources for UI elements, such as button captions, menu items, error messages, and dialog boxes. Refer to the Localization help topic for more information.

Free Blazor Utilities and Dev Tools

The following DevExpress Blazor products are available free-of-charge:

• Document metadata tool.
• Anchor navigation tool.

Troubleshooting

1. There was an unhandled exception on the current circuit, so this circuit will be terminated. For more details turn on detailed exceptions in 'CircuitOptions.DetailedErrors'.

If you see this error message or a similar message, add the following code to the ConfigureServices method declared in the Startup.cs file:

services.AddServerSideBlazor().AddCircuitOptions(options => { options.DetailedErrors = true; });

This provides more detailed information about these errors.

2. System.ArgumentNullException: Value cannot be null. (Parameter 'accessor')

This is a common Blazor exception that occurs if an EditForm's editor does not use two-way binding.

To fix the issue, do one of the following:

• Specify the Expression property for the properties you use. For example, if you use the SelectedItem property and the SelectedItemChanged event separately, specify the SelectedItemExpression property also.

  <DxComboBox Data="@Strings"
      SelectedItem="@selectedItem" 
      SelectedItemChanged="@SelectedItemChanged"
      SelectedItemExpression="@(() => selectedItem )">
  </DxComboBox>
  

• Implement the two-way binding in the EditForm.

3. Could not find 'X' in 'window.DxBlazor'.

Earlier, our clients' scripts were manually added to a project. Now, we automatically distribute them with the NuGet Package in the _content/DevExpress.Blazor/ folder (see the 6th item of the How to create a new project paragraph). So, our users may face such an issue if they reference an old version of our static files instead of the new one. For example, a similar issue was discussed in the I have a formlayout error when running a Blazor website SO thread.

If solutions suggested there do not help, create an issue here or submit a ticket in our Support Center so that we can investigate your case.

4. DxDataGrid in Blazor

If you use Blazor WebAssemly (aka client-side Blazor) with DxDataGrid, you may see the following exception in a browser:

"System.InvalidOperationException: No generic method 'Take' on type 'System.Linq.Queryable' is compatible with the supplied type arguments and arguments."

Do one of the following to resolve this issue:

• Set the BlazorLinkOnBuild property to false in the project file to disable linking with a MSBuild property.

  <PropertyGroup>
    ...
    <BlazorLinkOnBuild>false</BlazorLinkOnBuild>
  </PropertyGroup>
  

• Add the Linker.xml file and include the following assemblies and types:

  <?xml version="1.0" encoding="UTF-8" ?>
  ...
  <linker>
    <assembly fullname="mscorlib">
    ...
      <type fullname="System.Threading.WasmRuntime" />
    </assembly>
    <assembly fullname="System.Core">
    ...
      <type fullname="System.Linq.Expressions*" />
      <type fullname="System.Linq.Queryable*" />
      <type fullname="System.Linq.Enumerable*" />
      <type fullname="System.Linq.EnumerableRewriter*" />
    </assembly>
    ...
    <assembly fullname="[PUT YOUR ASSEMBLY NAME HERE]" />
  </linker>
  

  Specify this file as a MSBuild item in the project file.

  <ItemGroup>
    ...
    <BlazorLinkerDescriptor Include="Linker.xml" />
  </ItemGroup>
  

See Configure the Linker for ASP.NET Core Blazor for more information.

5. DxScheduler in Blazor

If you use Blazor WebAssembly with DxScheduler, you may see the following exception or a similar exception:

"System.MissingMethodException: Constructor on type 'System.ComponentModel.Int32Converter' not found."

Do one of the following to resolve this issue:

• Set the BlazorLinkOnBuild property to false in the project file to disable linking with a MSBuild property.

  <PropertyGroup>
    ...
    <BlazorLinkOnBuild>false</BlazorLinkOnBuild>
  </PropertyGroup>
  

• Add the Linker.xml file and include the following assembly:

  <?xml version="1.0" encoding="UTF-8" ?>
  ...
  <linker>
    ...
    <assembly fullname="System">
      <!--Use this line to include the entire assembly.-->
      <type fullname="System.ComponentModel*" />
      <!--Uncomment the following lines to include individual types. -->
      <!--<type fullname="System.ComponentModel.Int32Converter*" />
      <type fullname="System.ComponentModel.BooleanConverter*" />
      <type fullname="System.ComponentModel.DateTimeConverter*" />
      <type fullname="System.ComponentModel.StringConverter*" />-->
      ...
    </assembly>
  </linker>
  

  Specify this file as a MSBuild item in the project file.

  <ItemGroup>
    ...
    <BlazorLinkerDescriptor Include="Linker.xml" />
  </ItemGroup>
  

See Configure the Linker for ASP.NET Core Blazor for more information.

6. DxTabs are rendered incorrectly when the default Microsoft template is applied

If you create a new Blazor project based on the default Microsoft project template, the first tab of the DxTabs component can be rendered incorrectly.

This is caused by the following Microsoft issues:

• dotnet/aspnetcore#11267
• https://github.com/aspnet/Blazor/issues/1203

To resolve this issue, write more strict style rules in the site.css file so that they only apply .navbar templates.

Included Demo Modules

• Data Grid
  • Column Types
  • Sort Data
  • Grouping
  • Filter Row
  • Selection
  • Templates
  • Paging and Scrolling
  • Cascading Editors
  • Edit Form Validation
  • Remote Data Source
  • Large Data Source
  • Master-Detail View
  • HTML Decoration
• Pivot Grid
  • Overview
  • Templates
  • Large Data Source
  • Chart Integration
• Charts
  • Series Types
  • Dynamic Series
  • Range Series
  • Financial Series
  • Pie Series
  • Customization
  • Series Customization
• Scheduler
  • View Types
  • Recurring Appointments
• Data Editors
  • Calendar
  • CheckBox
  • ComboBox
  • Date Edit
  • List Box
  • Spin Edit
  • TagBox
  • Text Box
• Buttons
  • Button
• Navigation and Layout
  • Form Layout
  • Pager
  • Popup
  • Tabs
  • TreeView
• Form Validation

NuGet Package Change Log

Check out the NuGet package's version history.