New to Telerik UI for ASP.NET CoreStart a free 30-day trial

Getting Started with the OTPInput

This tutorial explains how to set up a basic Telerik UI for ASP.NET Core OTPInput component and highlights the major steps in the configuration of the component.

You will initialize an OTPInput component with a set of items. Then, you will use the events of the UI component. Finally, you can run the sample code in Telerik REPL and continue exploring the components.

Sample Telerik UI for ASP.NET Core OTPInput

Prerequisites

To successfully complete the tutorial, you need a project that is already configured to use the Telerik UI for ASP.NET Core components:

  • You can use the Telerik REPL playground and skip installing the components on your system and configuring a project.

  • You can prepare a Visual Studio project by following the following guide:

    • Creating a new pre-configured project for the Telerik UI for ASP.NET Core components from a project template.

1. Prepare the CSHTML File

The first step is to add the required directives at the top of the .cshtml document:

  • To use the Telerik UI for ASP.NET Core HtmlHelpers:

    cshtml
    @using Kendo.Mvc.UI
  • To use the Telerik UI for ASP.NET Core TagHelpers:

    cshtml
    @addTagHelper *, Kendo.Mvc

Optionally, you can structure the document by adding the desired HTML elements like headings, divs, paragraphs, and others.

Razor
    @using Kendo.Mvc.UI

    <h4>OTPInput with Predefined Items</h4>
    <br/>
    <div>

    </div>

2. Initialize the OTPInput

Use the OTPInput HtmlHelper or TagHelper to add the component to a page:

  • The Name() configuration method is mandatory as its value is used for the id and the name attributes of the OTPInput element.
  • The Items() collection contains the list of items representing the different input groups.
  • The Space() configuration controls the spacing behavior between each of the input groups.
Razor
    @using Kendo.Mvc.UI

    <h4>OTPInput with Predefined Items</h4>
    <br/>
    <div>
        @(Html.Kendo().OTPInput()
                .Name("otp")
                .Items(items => {
                    items.Add().GroupLength(3);
                    items.Add().GroupLength(2);
                    items.Add().GroupLength(3);
                })
                .Space(false)
        )
    </div>

3. Configure the Separator

The OTPInput components allows you to add a separator between each of the established input groups. In this tutorial, you will use the available SeparatorHandler() option to render a SVG Icon.

Razor
    @using Kendo.Mvc.UI

    <h4>OTPInput with Predefined Items</h4>
    <br/>
    <div>
        @(Html.Kendo().OTPInput()
                .Name("otp")
                .Items(items => {
                    items.Add().GroupLength(3);
                    items.Add().GroupLength(2);
                    items.Add().GroupLength(3);
                })
                .Space(false)
                .SeparatorHandler("separatorHandler")
        )
    </div>

4. Handle an OTPInput Event

The OTPInput component provides a convenient event for implementing your desired logic. In this tutorial, you will use the exposed Change() event to log a new entry in the browser's console.

Razor
    @using Kendo.Mvc.UI

    <h4>OTPInput with Predefined Items</h4>
    <br/>
    <div>
       @(Html.Kendo().OTPInput()
           .Name("otp")
           .Items(items => {
               items.Add().GroupLength(3);
               items.Add().GroupLength(2);
               items.Add().GroupLength(3);
           })
           .Space(false)
           .SeparatorHandler("separatorHandler")
           .Events(events => events.Change("onChange"))
       )
    </div>

5. (Optional) Reference Existing OTPInput Instances

You can reference the OTPInput instances that you have created and build on top of their existing configuration:

  1. Use the id attribute of the component instance to establish a reference.

    Html
    <script>
        var otpinputReference = $("#otpinput").getKendoOTPInput(); // otpinputReference is a reference to the existing OTPInput instance of the helper.
    </script>
  2. Use the OTPInput client-side API to control the behavior of the widget. In this example, you will use the enable method to disable the OTPInput.

    Html
    <script>
         var otpinputReference = $("#otpinput").getKendoOTPInput(); // otpinputReference is a reference to the existing OTPInput instance of the helper.
         otpinputReference.enable(false); 
    </script>

Next Steps

See Also