Getting Started

8 May 20257 minutes to read

The following section explains the required steps to build the MaskedTextBox component with its basic usage in step-by-step procedure.

Dependencies

The following list of dependencies are required to use the MaskedTextBox component in your application.

|-- @syncfusion/ej2-react-inputs
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-inputs
    |-- @syncfusion/ej2-react-base

Installation and configuration

To easily set up a React application, use create-vite-app, which provides a faster development environment, smaller bundle sizes, and optimized builds compared to traditional tools like create-react-app. For detailed steps, refer to the Vite installation instructions. Vite sets up your environment using JavaScript and optimizes your application for production.

Note: To create a React application using create-react-app, refer to this documentation for more details.

To create a new React application, run the following command.

npm create vite@latest my-app

To set-up a React application in TypeScript environment, run the following command.

npm create vite@latest my-app -- --template react-ts
cd my-app
npm run dev

To set-up a React application in JavaScript environment, run the following command.

npm create vite@latest my-app -- --template react
cd my-app
npm run dev

Adding Syncfusion® packages

All the available Essential® JS 2 packages are published in npmjs.com public registry.
You can choose the component that you want to install. For this application, we are going to use MaskedTextBox component.

To install MaskedTextBox component, use the following command

     npm install @syncfusion/ej2-react-inputs –save

Adding MaskedTextBox to the application

Now, you can start adding MaskedTextBox component to the application. We have added MaskedTextBox component in src/App.tsx file using following code.

[Class-component]

import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from "react";
import * as ReactDOM from "react-dom";

// initializes MaskedTextBox component
ReactDOM.render(<MaskedTextBoxComponent/>,document.getElementById('maskedContainer'));

[Functional-component]

import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from 'react';
import * as ReactDOM from 'react-dom';

// initializes MaskedTextBox component
// sets mask format to the MaskedTextBox
function App() {
  return <MaskedTextBoxComponent />;
}
ReactDOM.render(<App />, document.getElementById('maskedContainer'));

Set the mask

You can set the mask to the MaskedTextBox to validate the user input by using the mask property. To know more about the usage of mask and configuration, refer to this link.

The following example demonstrates the usage of mask element 0 that allows any single digit from 0 to 9.

[Class-component]

import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from "react";
import * as ReactDOM from "react-dom";

// initializes MaskedTextBox component
// sets mask format to the MaskedTextBox
ReactDOM.render(<MaskedTextBoxComponent mask={'000-000-0000'} />,document.getElementById('maskedContainer'));

[Functional-component]

import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from 'react';
import * as ReactDOM from 'react-dom';

// initializes MaskedTextBox component
// sets mask format to the MaskedTextBox
function App() {
  return <MaskedTextBoxComponent mask={'000-000-0000'} />;
}
ReactDOM.render(<App />, document.getElementById('maskedContainer'));

Adding CSS reference

Import the MaskedTextBox component’s required CSS references as follows in src/App.css.

@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-react-inputs/styles/material.css";

Note: If you want to refer the combined component styles, please make use of our CRG (Custom Resource Generator) in your application.

Run the application

Now run the npm run dev command in the console to start the development server. This command compiles your code and serves the application locally, opening it in the browser.

npm run dev

The following example shows the MaskedTextBox.

[Class-component]

import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from "react";
import * as ReactDOM from "react-dom";
// initializes MaskedTextBox component
// sets value to the MaskedTextBox
export default class App extends React.Component {
    render() {
        return (<div>
            <label className='label'>Enter the mobile number</label>
            <MaskedTextBoxComponent mask={'000-000-0000'}/>
          </div>);
    }
}
;
ReactDOM.render(<App />, document.getElementById('maskedContainer'));
import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from "react";
import * as ReactDOM from "react-dom";

// initializes MaskedTextBox component
// sets value to the MaskedTextBox
export default class App extends React.Component<{}, {}> {
    public render() {
        return (
          <div>
            <label className='label'>Enter the mobile number</label>
            <MaskedTextBoxComponent mask={'000-000-0000'} />
          </div>
        );
    }
};
ReactDOM.render(<App />, document.getElementById('maskedContainer'));

[Functional-component]

import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
// initializes MaskedTextBox component
// sets value to the MaskedTextBox
function App() {
    return (<div>
      <label className="label">Enter the mobile number</label>
      <MaskedTextBoxComponent mask={'000-000-0000'}/>
    </div>);
}
ReactDOM.render(<App />, document.getElementById('maskedContainer'));
import { MaskedTextBoxComponent } from '@syncfusion/ej2-react-inputs';
import * as React from 'react';
import * as ReactDOM from 'react-dom';

// initializes MaskedTextBox component
// sets value to the MaskedTextBox
function App() {
  return (
    <div>
      <label className="label">Enter the mobile number</label>
      <MaskedTextBoxComponent mask={'000-000-0000'} />
    </div>
  );
}
ReactDOM.render(<App />, document.getElementById('maskedContainer'));

See Also