Getting Started with Blazor MultiColumn ComboBox in Blazor Web App

9 Jul 20269 minutes to read

This section briefly explains how to include the Blazor MultiColumn ComboBox component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.

To get started quickly with the Blazor MultiColumn ComboBox component, you can check the video below.

Create a new Blazor Web App

Create a Blazor Web App using Visual Studio via Microsoft Templates or the Blazor Extension. For detailed instructions, refer to the Blazor Web App Getting Started documentation.

Run the following command to create a new Blazor Web App.

dotnet new blazor -o BlazorWebApp --interactivity Auto
cd BlazorWebApp
cd BlazorWebApp.Client

Alternatively, create a Blazor Web App using Visual Studio Code via Microsoft Templates, the Blazor Extension, or the C# Dev Kit extension.

Run the following command to create a new Blazor Web App.

dotnet new blazor -o BlazorWebApp --interactivity Auto
cd BlazorWebApp
cd BlazorWebApp.Client

NOTE

Configure the appropriate Interactive render mode and Interactivity location while creating a Blazor Web App. For detailed information, refer to the interactive render mode documentation.

Install the required Blazor packages

Install Syncfusion.Blazor.MultiColumnComboBox and Syncfusion.Blazor.Themes NuGet packages. All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details. If using the WebAssembly or Auto render modes in the Blazor Web App, install these packages in the .Client project.

  1. Go to Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
  2. Search the required NuGet packages (Syncfusion.Blazor.MultiColumnComboBox and Syncfusion.Blazor.Themes) and install them.

Alternatively, you can install the same packages using the Package Manager Console with the following commands.

Install-Package Syncfusion.Blazor.MultiColumnComboBox -Version 34.1.29
Install-Package Syncfusion.Blazor.Themes -Version 34.1.29

Open the terminal and run the following commands.

dotnet add package Syncfusion.Blazor.MultiColumnComboBox -v 34.1.29
dotnet add package Syncfusion.Blazor.Themes -v 34.1.29

Open the command prompt and run the following commands.

dotnet add package Syncfusion.Blazor.MultiColumnComboBox -v 34.1.29
dotnet add package Syncfusion.Blazor.Themes -v 34.1.29

Add import namespaces

After the packages are installed, open the ~/_Imports.razor file in the .Client project and import the Syncfusion.Blazor and Syncfusion.Blazor.MultiColumnComboBox namespaces.

@using Syncfusion.Blazor
@using Syncfusion.Blazor.MultiColumnComboBox

Register the Blazor service

Open the Program.cs file in Blazor Web App and register the Blazor service. If the Interactive Render Mode is set to WebAssembly or Auto, register the Blazor service in Program.cs files of both the server and client projects in your Blazor Web App.

....
using Syncfusion.Blazor;
....
builder.Services.AddSyncfusionBlazor();
....

Add stylesheet and script resources

The theme stylesheet and script can be accessed from NuGet through Static Web Assets. Include the stylesheet and script references in the App.razor file.

...
<link href="_content/Syncfusion.Blazor.Themes/fluent2.css" rel="stylesheet" />
...
<script src="_content/Syncfusion.Blazor.Core/scripts/syncfusion-blazor.min.js" type="text/javascript"></script>

Add Blazor MultiColumn ComboBox component

Open a Razor file located in the ~/Pages/*.razor (for example, Home.razor) and add the Blazor MultiColumn ComboBox component inside the razor file.

NOTE

If the interactivity location is set to Per page/component in the Web App, define a render mode at the top of the razor file (for example, InteractiveServer, InteractiveWebAssembly, or InteractiveAuto). If the Interactivity is set to Global with Auto or WebAssembly, the render mode is automatically configured in the App.razor file by default.

@rendermode InteractiveAuto

<SfMultiColumnComboBox TItem="string" TValue="string" Placeholder="Select any product"></SfMultiColumnComboBox>

Run the application

Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. The Blazor MultiColumn ComboBox component will render in your default web browser.

Open the terminal and navigate to the main project folder (for example, BlazorWebApp) and run the following command.

cd ..
cd BlazorWebApp
dotnet run

Open the command prompt and navigate to the main project folder (for example, BlazorWebApp) and run the following command.

cd ..
cd BlazorWebApp
dotnet run
Blazor MultiColumn ComboBox Component

Binding Data Source and Mapping Fields

After initialization, populate the MultiColumn ComboBox with data using the DataSource property. In this case, the MultiColumn ComboBox binds its DataSource to the Products list, which contains multiple product columns. Both the ValueField and TextField properties are set to the Name property of the Product class, ensuring that product names are displayed in the dropdown. The @bind-Value is used to bind the selected value, with an initial value of “Smart phone” pre-selected in this example.

<SfMultiColumnComboBox @bind-Value="@Value" DataSource="@Products" ValueField="Name" TextField="Name" Placeholder="Select any product"></SfMultiColumnComboBox>

@code {
    public class Product
    {
        public string Name { get; set; }
        public decimal Price { get; set; }
        public string Availability { get; set; }
        public string Category { get; set; }
        public double Rating { get; set; }
    }
    private List<Product> Products = new List<Product>();
    private string Value { get; set; } = "Smartphone";
    protected override Task OnInitializedAsync()
    {
        Products = new List<Product>
        {
            new Product { Name = "Laptop", Price = 999.99m, Availability = "In Stock", Category = "Electronics", Rating = 4.5 },
            new Product { Name = "Smartphone", Price = 599.99m, Availability = "Out of Stock", Category = "Electronics", Rating = 4.3 },
            new Product { Name = "Tablet", Price = 299.99m, Availability = "In Stock", Category = "Electronics", Rating = 4.2 },
            new Product { Name = "Headphones", Price = 49.99m, Availability = "In Stock", Category = "Accessories", Rating = 4.0 }
        };
        return base.OnInitializedAsync();
    }
}
Blazor MultiColumn ComboBox with Data Binding

Configuring the Columns

The MultiColumn ComboBox supports auto-generating columns from the data source. You can also customize the column header text, adjust Width for optimal display, and set TextAlign (left, center, or right) to enhance readability.

<SfMultiColumnComboBox @bind-Value="@Value" DataSource="@Products" PopupWidth="600px" ValueField="Name" TextField="Name" Placeholder="Select any product">
    <MultiColumnComboboxColumns>
        <MultiColumnComboboxColumn Field="Name" Width="200px" TextAlign="Syncfusion.Blazor.Grids.TextAlign.Center"></MultiColumnComboboxColumn>
        <MultiColumnComboboxColumn Field="Price" Width="200px" TextAlign="Syncfusion.Blazor.Grids.TextAlign.Center"></MultiColumnComboboxColumn>
        <MultiColumnComboboxColumn Field="Availability" Width="200px" TextAlign="Syncfusion.Blazor.Grids.TextAlign.Center"></MultiColumnComboboxColumn>
    </MultiColumnComboboxColumns>
</SfMultiColumnComboBox>
Blazor MultiColumn ComboBox with Data Binding

Configuring the Popup List

By default, the popup list width matches the input element width, and the height is 350px. Customize the popup height and width using PopupHeight and PopupWidth.

<SfMultiColumnComboBox @bind-Value="@Value" DataSource="@Products" PopupHeight="350px" PopupWidth="400px" ValueField="Name" TextField="Name" Placeholder="Select any product"></SfMultiColumnComboBox>
Customizing Popup Height and Width in Blazor MultiColumn ComboBox

NOTE

View Sample in GitHub.

See also

  1. Getting Started with Blazor WebAssembly Standalone App
  2. Getting Started with Blazor Web App
  3. Filtering in Blazor MultiColumn ComboBox Component
  4. Adding Custom Value to Blazor MultiColumn ComboBox Component