Search results

Getting Started

This section briefly explains about how to include Blazor ListBox in your client-side Blazor application. You can refer Getting Started with Syncfusion Blazor for Client-side in Visual Studio 2019 Preview page for introduction and configure the common specifications.

Importing Syncfusion Blazor component in the application

  1. Install Syncfusion.EJ2.Blazor NuGet package to the application by using the NuGet Package Manager. Please ensure to check the Include prerelease option.
  2. You can add the client-side resources through CDN or local npm package in the <head> element of the ~/wwwroot/index.html page.
<head>
    <environment include="Development">
        <link href="https://cdn.syncfusion.com/ej2/17.3.29/material.css" rel="stylesheet" />
        <script src="https://cdn.syncfusion.com/ej2/17.3.29/dist/ej2.min.js"></script>
     </environment>
</head>

Adding component package to the application

Open /_Imports.razor file and import the Syncfusion.EJ2.Blazor.DropDowns packages otherwise import these packages in the individual razor pages.

@using Syncfusion.EJ2.Blazor
@using Syncfusion.EJ2.Blazor.DropDowns

Adding ListBox component to the application

Now, add the Blazor ListBox component in razor page in the Pages folder. For example, the ListBox component is added in the ~/Pages/Index.razor page.

@using Syncfusion.EJ2.Blazor

<EjsListBox TValue="string[]"></EjsListBox>

Binding data source

After initializing, populate the ListBox with data using the DataSource property. Here, an array of object values is passed to the ListBox component.

The following example illustrates the output in your browser.

@using Syncfusion.EJ2.Blazor.DropDowns

<EjsListBox TValue="string[]" DataSource="@Vehicles">
    <ListBoxFieldSettings Text="Text" Value="Id" />
</EjsListBox>
@code {
    public List<VehicleData> Vehicles = new List<VehicleData> {
        new VehicleData { Text = "Hennessey Venom", Id = "Vehicle-01" },
        new VehicleData { Text = "Bugatti Chiron", Id = "Vehicle-02" },
        new VehicleData { Text = "Bugatti Veyron Super Sport", Id = "Vehicle-03" },
        new VehicleData { Text = "SSC Ultimate Aero", Id = "Vehicle-04" },
        new VehicleData { Text = "Koenigsegg CCR", Id = "Vehicle-05" },
        new VehicleData { Text = "McLaren F1", Id = "Vehicle-06" },
        new VehicleData { Text = "Aston Martin One- 77", Id = "Vehicle-07" },
        new VehicleData { Text = "Jaguar XJ220", Id = "Vehicle-08" }
    };

    public class VehicleData {
      public string Text  { get; set; }
      public string Id  { get; set; }
    }
}

TValue is type of value in the datasource to resolve type inference. It is generic type and can be given as string[], int[].

Run the application

After successful compilation of your application, simply press F5 to run the application. The Blazor ListBox component will render in the web browser as shown below.

ListBox

See Also