Getting Started with Blazor Input Mask Component

4 Nov 20255 minutes to read

This section explains how to include the Blazor MaskedTextBox component in a Blazor WebAssembly app using Visual Studio and Visual Studio Code.

To get started quickly with the Blazor MaskedTextBox component, watch this video or explore the corresponding GitHub sample.

Prerequisites

Create a new Blazor App in Visual Studio

CBlazor WebAssembly App using Visual Studio via Microsoft templates or the Syncfusion® Blazor Extension.

Install Syncfusion® Blazor Inputs and Themes NuGet in the App

To add the Blazor MaskedTextBox component to the app, open NuGet Package Manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), then search for and install Syncfusion.Blazor.Inputs and Syncfusion.Blazor.Themes. Alternatively, use the following Package Manager commands.

Install-Package Syncfusion.Blazor.Inputs -Version 31.2.12
Install-Package Syncfusion.Blazor.Themes -Version 31.2.12

NOTE

Syncfusion® Blazor components are available in nuget.org. Refer to NuGet packages topic for available NuGet packages list with component details.

Prerequisites

Create a new Blazor App in Visual Studio Code

Create a Blazor WebAssembly App using Visual Studio Code via Microsoft templates or the Syncfusion® Blazor Extension.

Alternatively, create a WebAssembly application using the following commands in the terminal (Ctrl+`).

dotnet new blazorwasm -o BlazorApp
cd BlazorApp

Install Syncfusion® Blazor Inputs and Themes NuGet in the App

  • Press Ctrl+` to open the integrated terminal in Visual Studio Code.
  • Ensure the terminal is in the project root directory where the .csproj file is located.
  • Run the following commands to install the Syncfusion.Blazor.Inputs and Syncfusion.Blazor.Themes NuGet packages and restore dependencies.
dotnet add package Syncfusion.Blazor.Inputs -v 31.2.12
dotnet add package Syncfusion.Blazor.Themes -v 31.2.12
dotnet restore

NOTE

Syncfusion® Blazor components are available in nuget.org. Refer to NuGet packages topic for available NuGet packages list with component details.

Register Syncfusion® Blazor Service

Open ~/_Imports.razor and import the Syncfusion.Blazor and Syncfusion.Blazor.Inputs namespaces.

@using Syncfusion.Blazor
@using Syncfusion.Blazor.Inputs

Now register the Syncfusion® Blazor service in the ~/Program.cs file of the Blazor WebAssembly app.

using Microsoft.AspNetCore.Components.Web;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Syncfusion.Blazor;

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<App>("#app");
builder.RootComponents.Add<HeadOutlet>("head::after");

builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });

builder.Services.AddSyncfusionBlazor();
await builder.Build().RunAsync();
....

Add stylesheet and script resources

The theme stylesheet and script are provided via NuGet through Static Web Assets. Include the stylesheet and script references in the <head> section of ~/index.html.

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

NOTE

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

Add Blazor MaskedTextBox component

Add the Syncfusion® Blazor MaskedTextBox component to ~/Pages/Index.razor.

<SfMaskedTextBox></SfMaskedTextBox>
  • Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to launch the application. This renders the Syncfusion® Blazor MaskedTextBox component in the default web browser.
Blazor MaskedTextBox Component

Set the mask

Set a mask on the MaskedTextBox to validate user input by using the Mask property.

The following example demonstrates the mask element 0, which allows any single digit from 0 to 9.

<SfMaskedTextBox Mask='000-000-0000'></SfMaskedTextBox>
Blazor MaskedTextBox with Mask

See also