DevExpress UI for Blazor

This project demonstrates the DevExpress UI Components for Blazor.

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

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

Live Demo

  Check out this demo in live.

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/.

Version Compatibility

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

.NET Core 3.0 version	DevExpress.Blazor.nuget version
.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*
.NET Core 3.0 RC1	0.4.1 RC
.NET Core 3.0 RC1	0.4.0 RC
.NET Core 3.0 RC1	0.3.3 Beta
.NET Core 3.0 Preview 9	0.3.2 Beta
.NET Core 3.0 Preview 9	0.3.1 Beta
.NET Core 3.0 Preview 8	0.3.0 Beta
.NET Core 3.0 Preview 8	0.2.0 Beta
.NET Core 3.0 Preview 7	0.1.0 Beta
.NET Core 3.0 Preview 6	0.0.12
.NET Core 3.0 Preview 6	0.0.11
.NET Core 3.0 Preview 6	0.0.10
.NET Core 3.0 Preview 5	0.0.9
.NET Core 3.0 Preview 5	0.0.8
.NET Core 3.0 Preview 5	0.0.7
.NET Core 3.0 Preview 5	0.0.6
.NET Core 3.0 Preview 5	0.0.5
.NET Core 3.0 Preview 4	0.0.4
.NET Core 3.0 Preview 3	0.0.3

* 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 (client-side Blazor) or server-side ASP.NET Core (server-side Blazor). 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.

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

   

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

   Navigate to:

   

   Install the "DevExpress.Blazor" NuGet package.

   

5. Start the application.

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

   

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

   Navigate to:

   

   Install the "DevExpress.Blazor" NuGet package.

   

4. Build the project.

5. Make sure the following folder is automatically created in your project’s wwwroot directory:

   Lib/dx-blazor
       dx-blazor/.gitignore
       dx-blazor/modules/
       dx-blazor/dx-blazor.js
       dx-blazor/dx-blazor.css
   

   For existing Blazor projects, copy the DevExpress static files from the Lib/dx-blazor folder to the appropriate folder in your project.

   The Lib/dx-blazor folder is automatically cleared while the project is built and contains static files for an installed nuget package only. Do not store your files here.

6. Link the dx-blazor.js and dx-blazor.css files to your layout’s HEAD section:

   • For server-side Blazor, add the lines below to the _Host.cshtml file.
   • For client-side Blazor, add the lines below to the Index.cshtml file.

   <head>
       ...
       <link href="lib/dx-blazor/dx-blazor.css" rel="stylesheet" />
       <script src="lib/dx-blazor/dx-blazor.js"></script>
   </head>

   Reference this JavaScript file only because the dx-blazor/dx-blazor.js file is the entry point for DevExpress module files.

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

   @using DevExpress.Blazor

8. Your application is ready to use DevExpress Blazor.

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. 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 lib/dx-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.

3. DxDataGrid in Blazor

If you use 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>
  

• Include the following assemblies and types in the Linker.xml file:

  <?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>
  

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

4. DxScheduler in Blazor

If you use client-side Blazor 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>
  

• Include the following assembly and types in the Linker.xml file:

  <?xml version="1.0" encoding="UTF-8" ?>
  ...
  <linker>
    ...
    <assembly fullname="System">
      <type fullname="System.ComponentModel*" />
      <!--<type fullname="System.ComponentModel.Int32Converter*" />
      <type fullname="System.ComponentModel.BooleanConverter*" />
      <type fullname="System.ComponentModel.DateTimeConverter*" />
      <type fullname="System.ComponentModel.StringConverter*" />-->
      ...
    </assembly>
  </linker>
  

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

5. 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
  • Data Filter Row
  • Selection
  • Templates
  • Scrolling
  • Virtual Scrolling
  • Cascading Editors
  • Edit Form Template Validation
  • Master-Detail
  • Large Datasets
• Pivot Grid
  • Data Binding Basics
  • Templates
  • Large Datasets
  • Chart Integration
• Charts
  • Series Types
  • Dynamic Series
  • Range Series
  • Financial Series
  • Pie Series
  • Customization
  • Series Customization
• Scheduler
  • Day View
  • Work Week View
  • Week View
  • Recurring Appointments
• Data Editors
  • Calendar
  • Check Box
  • ComboBox
  • Date Edit
  • List Box
  • Spin Edit
  • Text Box
• Navigation and Layout
  • Form Layout
  • Pager
  • Popup
  • Tabs
  • TreeView
• Form Validation

NuGet Package Change Log

Check out thе NuGet package's version history.