Skip to content

getting-started-with-web-app.md

Latest commit

 

History

History
272 lines (178 loc) · 13.6 KB

getting-started-with-web-app.md

File metadata and controls

272 lines (178 loc) · 13.6 KB
layout post
title Getting Started with Syncfusion AutoComplete in Blazor Web App
description Checkout and learn about the documentation for getting started with Blazor AutoComplete Component in Blazor Web App.
platform Blazor
component AutoComplete
documentation ug

Getting Started with Blazor AutoComplete in Blazor Web App

This section briefly explains about how to include Syncfusion® Blazor AutoComplete component in your Blazor Web App using Visual Studio, Visual Studio Code, and the .NET CLI.

{% tabcontents %}

{% tabcontent Visual Studio %}

Prerequisites

Create a new Blazor Web App in Visual Studio

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

{% endtabcontent %}

{% tabcontent Visual Studio Code %}

Prerequisites

Create a new Blazor Web App in Visual Studio Code

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

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands in the integrated terminal (Ctrl+`).

{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}

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

{% endhighlight %} {% endtabs %}

{% endtabcontent %}

{% tabcontent .NET CLI %}

Prerequisites

Install the latest version of .NET SDK. If you previously installed the SDK, you can determine the installed version by executing the following command in a command prompt (Windows) or terminal (macOS) or command shell (Linux).

{% tabs %} {% highlight c# tabtitle=".NET CLI" %}

dotnet --version

{% endhighlight %} {% endtabs %}

Create a Blazor Web App using .NET CLI

Run the following command to create a new Blazor Web App in a command prompt (Windows) or terminal (macOS) or command shell (Linux). For detailed instructions, refer to the Blazor Web App Getting Started documentation.

For example, in a Blazor Web App with the Auto interactive render mode, use the following commands:

{% tabs %} {% highlight c# tabtitle="Blazor Web App" %}

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

{% endhighlight %} {% endtabs %}

This command creates a new Blazor Web App and places it in a new directory called BlazorWebApp inside your current location. See the Create a Blazor App and dotnet new CLI command topics for more details.

{% endtabcontent %}

{% endtabcontents %}

N> 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 Syncfusion® Blazor packages

Install Syncfusion.Blazor.DropDowns and Syncfusion.Blazor.Themes NuGet packages in your project using the NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), or the integrated terminal in Visual Studio Code (dotnet add package), or the .NET CLI.

Alternatively, run the following commands in the Package Manager Console to achieve the same.

{% tabs %} {% highlight C# tabtitle="Package Manager" %}

Install-Package Syncfusion.Blazor.DropDowns -Version {{ site.releaseversion }} Install-Package Syncfusion.Blazor.Themes -Version {{ site.releaseversion }}

{% endhighlight %} {% endtabs %}

If using the WebAssembly or Auto render modes in the Blazor Web App, install these packages in the client project.

N> All Syncfusion Blazor packages are available on nuget.org. See the NuGet packages topic for details.

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.DropDowns namespaces.

{% tabs %} {% highlight C# tabtitle="~/_Imports.razor" %}

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

{% endhighlight %} {% endtabs %}

Register Syncfusion® Blazor service

Register the Syncfusion® Blazor service in the Program.cs file of your Blazor Web App.

{% tabs %} {% highlight c# tabtitle="Program.cs" %}

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

{% endhighlight %} {% endtabs %}

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

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 ~/Components/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>

N> Check out the Blazor Themes topic to discover various methods (Static Web Assets, CDN, and CRG) for referencing themes in the Blazor application. Also, check out the Adding Script Reference topic to learn different approaches for adding script references in the Blazor application.

Add Syncfusion® Blazor AutoComplete component

Add the Syncfusion® Blazor AutoComplete component in the ~/Components/Pages/*.razor file. If the interactivity location is set to Per page/component in the Web App, define a render mode at the top of the ~Pages/*.razor file. (For example, InteractiveServer, InteractiveWebAssembly or InteractiveAuto).

N> If the Interactivity Location is set to Global with Auto or WebAssembly, the render mode is automatically configured in the App.razor file by default.

{% tabs %} {% highlight razor %}

@* desired render mode define here *@ @rendermode InteractiveAuto

{% endhighlight %} {% endtabs %}

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

@using Syncfusion.Blazor.DropDowns

@code {

public class Country
{
    public string Name { get; set; }
    public string Code { get; set; }
}

List<Country> LocalData = new List<Country> {
    new Country() { Name = "Australia", Code = "AU" },
    new Country() { Name = "Bermuda", Code = "BM" },
    new Country() { Name = "Canada", Code = "CA" },
    new Country() { Name = "Cameroon", Code = "CM" },
    new Country() { Name = "Denmark", Code = "DK" }
};

}

{% endhighlight %} {% endtabs %}

  • Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This will render the Syncfusion® Blazor AutoComplete component in the default web browser.

{% previewsample "https://blazorplayground.syncfusion.com/embed/LtBJZMreLmNLRbiw?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor AutoComplete Component" %}

N> View Sample in GitHub

Binding data source

After initialization, populate the AutoComplete with data using the DataSource property.

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

@using Syncfusion.Blazor.DropDowns

@code {

public class Country
{
    public string Name { get; set; }
    public string Code { get; set; }
}

List<Country> LocalData = new List<Country> {
    new Country() { Name = "Australia", Code = "AU" },
    new Country() { Name = "Bermuda", Code = "BM" },
    new Country() { Name = "Canada", Code = "CA" },
    new Country() { Name = "Cameroon", Code = "CM" },
    new Country() { Name = "Denmark", Code = "DK" },
    new Country() { Name = "France", Code = "FR" },
    new Country() { Name = "Finland", Code = "FI" },
    new Country() { Name = "Germany", Code = "DE" },
    new Country() { Name = "Greenland", Code = "GL" },
    new Country() { Name = "Hong Kong", Code = "HK" },
    new Country() { Name = "India", Code = "IN" },
    new Country() { Name = "Italy", Code = "IT" },
    new Country() { Name = "Japan", Code = "JP" },
    new Country() { Name = "Mexico", Code = "MX" },
    new Country() { Name = "Norway", Code = "NO" },
    new Country() { Name = "Poland", Code = "PL" },
    new Country() { Name = "Switzerland", Code = "CH" },
    new Country() { Name = "United Kingdom", Code = "GB" },
    new Country() { Name = "United States", Code = "US" },
};

}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/hjhfjCLSBGLRJZjX?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Blazor AutoComplete with Data Binding" %}

Configure the suggestion list

By default, the suggestion list width automatically matches the AutoComplete input element, and the suggestion list height is 300px. Customize the popup size using the PopupHeight and PopupWidth properties.

{% tabs %} {% highlight razor tabtitle="Home.razor" %}

{% endhighlight %} {% endtabs %}

{% previewsample "https://blazorplayground.syncfusion.com/embed/LDVJXCByVQxticee?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" backgroundimage "Customizing Popup Height and Width in Blazor AutoComplete" %}

See also