Search results

Getting started with JavaScript (ES5) AutoComplete control

03 Aug 2021 / 7 minutes to read

The Essential JS 2 for JavaScript (global script) is an ES5 formatted pure JavaScript framework which can be directly used in latest web browsers.

Dependencies

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

Copied to clipboard
|-- @syncfusion/ej2-dropdowns
    |-- @syncfusion/ej2-base
    |-- @syncfusion/ej2-data
    |-- @syncfusion/ej2-inputs
    |-- @syncfusion/ej2-lists
    |-- @syncfusion/ej2-navigations
    |-- @syncfusion/ej2-popups
        |-- @syncfusion/ej2-buttons

Component Initialization

The Essential JS 2 JavaScript components can be initialized by using either of the following ways.

  • Using local script and style references in a HTML page.
  • Using CDN link for script and style reference.

Using local script and style references in a HTML page

Step 1: Create an app folder myapp for Essential JS 2 JavaScript components.

Step 2: You can get the global scripts and styles from the Essential Studio JavaScript (Essential JS 2) build installed location.

Syntax:

Script: **(installed location)**/Syncfusion/Essential Studio/{RELEASE_VERSION}/Essential JS 2/{PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Styles: **(installed location)**/Syncfusion/Essential Studio/{RELEASE_VERSION}/Essential JS 2/{PACKAGE_NAME}/styles/material.css

Example:

Script: C:/Program Files (x86)/Syncfusion/Essential Studio/15.4.30/Essential JS 2/ej2-dropdowns/dist/global/ej2-dropdowns.min.js

Styles: C:/Program Files (x86)/Syncfusion/Essential Studio/15.4.30/Essential JS 2/ej2-dropdowns/styles/material.css

Step 3: Create a folder myapp/resources and copy/paste the global scripts and styles from the above installed location to myapp/resources location.

Step 4: Create a HTML page (index.html) in myapp location and add the Essentials JS 2 script and style references.

Copied to clipboard
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
        <title>Essential JS 2</title>
        <!-- Essential JS 2 material theme -->
        <link href="resources/base/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/inputs/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/lists/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/popups/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/buttons/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/dropdowns/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 autoComplete's dependent scripts -->
        <script src="resources/ej2-base.min.js" type="text/javascript"></script>
        <script src="resources/ej2-data.min.js" type="text/javascript"></script>
        <script src="resources/ej2-inputs.min.js" type="text/javascript"></script>
        <script src="resources/ej2-lists.min.js" type="text/javascript"></script>
        <script src="resources/ej2-popups.min.js" type="text/javascript"></script>
        <script src="resources/ej2-buttons.min.js" type="text/javascript"></script>
        <!-- Essential JS 2 autoComplete's global script -->
        <script src="resources/ej2-dropdowns.min.js" type="text/javascript"></script>
   </head>
   <body>
   </body>
  </html>

Step 5: Now, add the input element and initiate the Essential JS 2 AutoComplete component in the index.html by using following code

The below html code example shows the dependency of autoComplete.

Copied to clipboard
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
        <title>Essential JS 2</title>
        <!-- Essential JS 2 material theme -->
        <link href="resources/base/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/inputs/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/lists/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/popups/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/buttons/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="resources/dropdowns/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 autoComplete's dependent scripts -->
        <script src="resources/ej2-base.min.js" type="text/javascript"></script>
        <script src="resources/ej2-data.min.js" type="text/javascript"></script>
        <script src="resources/ej2-inputs.min.js" type="text/javascript"></script>
        <script src="resources/ej2-lists.min.js" type="text/javascript"></script>
        <script src="resources/ej2-popups.min.js" type="text/javascript"></script>
        <script src="resources/ej2-buttons.min.js" type="text/javascript"></script>
        <!-- Essential JS 2 autoComplete's global script -->
        <script src="resources/ej2-dropdowns.min.js" type="text/javascript"></script>
   </head>
   <body>
        <!-- Add the HTML <input> element  -->
         <input type="text" id='atcelement' />
        <script>
            // initialize autoComplete component
           var autocomplete = new ej.dropdowns.AutoComplete();
            // Render initialized autoComplete.
            autocomplete.appendTo('#atcelement')
        </script>
   </body>
  </html>

Step 6: Now, run the index.html in web browser, it will render the Essential JS 2 AutoComplete component.

Step 1: Create an app folder myapp for the Essential JS 2 JavaScript components.

Step 2: The Essential JS 2 component’s global scripts and styles are already hosted in the below CDN link formats.

Syntax:

Script: http://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

Styles: http://cdn.syncfusion.com/ej2/{PACKAGE_NAME}/styles/material.css

Example:

Script: http://cdn.syncfusion.com/ej2/ej2-dropdowns/dist/global/ej2-dropdowns.min.js

Styles: http://cdn.syncfusion.com/ej2/ej2-dropdowns/styles/material.css

Step 3: Create a HTML page (index.html) in myapp location and add the CDN link references. Now, add the input element and initiate the Essential JS 2 AutoComplete component in the index.html by using following code.

Source
Preview
index.html
Copied to clipboard
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
        <title>Essential JS 2</title>
         <!-- Essential JS 2 autoComplete's dependent material theme -->
        <link href="//cdn.syncfusion.com/ej2/ej2-base/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-inputs/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-dropdowns/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 all script -->
        <!-- <script src="https://cdn.syncfusion.com/ej2/dist/ej2.min.js" type="text/javascript"></script> -->

        <!-- Essential JS 2 autoComplete's dependent scripts -->
        <script src="//cdn.syncfusion.com/ej2/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-data/dist/global/ej2-data.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-dropdowns/dist/global/ej2-dropdowns.min.js" type="text/javascript"></script>

   </head>
   <body>
       <!-- Add the HTML <input> element  -->
         <input type="text" id='atcelement' />
        <script>
            // initialize autoComplete component
           var autocomplete = new ej.dropdowns.AutoComplete();
            // Render initialized autoComplete.
            autocomplete.appendTo('#atcelement')
        </script>
   </body>
  </html>

Step 4: Now, run the index.html in web browser, it will render the Essential JS 2 AutoComplete component.

Binding data source

After initialization, populate the AutoComplete with data using the dataSource property. Here, an array of string values is passed to the AutoComplete component.

Copied to clipboard
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
        <title>Essential JS 2</title>
         <!-- Essential JS 2 autoComplete's dependent material theme -->
        <link href="//cdn.syncfusion.com/ej2/ej2-base/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-inputs/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-dropdowns/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 all script -->
        <!-- <script src="https://cdn.syncfusion.com/ej2/dist/ej2.min.js" type="text/javascript"></script> -->

        <!-- Essential JS 2 autoComplete's dependent scripts -->
        <script src="//cdn.syncfusion.com/ej2/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-data/dist/global/ej2-data.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-dropdowns/dist/global/ej2-dropdowns.min.js" type="text/javascript"></script>
   </head>
   <body>
       <!-- Add the HTML <input> element  -->
         <input type="text" id='atcelement' />
        <script>
            let sportsData = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Gymnastics', 'Hockey', 'Rugby', 'Snooker', 'Tennis'];
            // initialize AutoComplete component
            var listObj = new ej.dropdowns.AutoComplete({
            //set the data to dataSource property
                dataSource: sportsData,
                });
            listObj.appendTo('#atcelement');
        </script>
   </body>
  </html>

Custom values

The AutoComplete allows the user to give input as custom value which is not required to present in predefined set of values. By default, this support is enabled by allowCustom property. The custom value will be sent to post back handler when a form is about to be submitted.

Source
Preview
index.html
Copied to clipboard
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
        <title>Essential JS 2</title>
         <!-- Essential JS 2 autoComplete's dependent material theme -->
        <link href="//cdn.syncfusion.com/ej2/ej2-base/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-inputs/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-dropdowns/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 all script -->
        <!-- <script src="https://cdn.syncfusion.com/ej2/dist/ej2.min.js" type="text/javascript"></script> -->

        <!-- Essential JS 2 autoComplete's dependent scripts -->
        <script src="//cdn.syncfusion.com/ej2/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-data/dist/global/ej2-data.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-dropdowns/dist/global/ej2-dropdowns.min.js" type="text/javascript"></script>
   </head>
   <body>
       <!-- Add the HTML <input> element  -->
         <input type="text" id='atcelement' />
        <script>
            let sportsData = [
            { Id: 'Game1', Game: 'Badminton' },
            { Id: 'Game2', Game: 'Basketball' },
            { Id: 'Game3', Game: 'Cricket' },
            { Id: 'Game4', Game: 'Football' },
            { Id: 'Game5', Game: 'Golf' },
            { Id: 'Game6', Game: 'Hockey' },
            { Id: 'Game7', Game: 'Rugby' },
            { Id: 'Game8', Game: 'Snooker' }
            ];
            // initialize AutoComplete component
            var listObj = new ej.dropdowns.AutoComplete({
                //set the data to dataSource property
                dataSource: sportsData,
                // By default, its enabled. For your better understanding, showcase this property.
                allowCustom: true,
                // maps the appropriate column to fields property
                fields: { value: 'Game' },
                // set placeholder to AutoComplete input element
                placeholder: "Find a game"});
            listObj.appendTo('#atcelement');
        </script>
   </body>
  </html>

Configure the suggestion list

By default, suggestion list width automatically adjusts according to the AutoComplete input element’s width, and the height of the suggestion list has ‘300px’.

The height and width of the popup list can also be customized using the popupHeight and popupWidth property respectively.

In the following sample, suggestion list’s width and height are configured.

Source
Preview
index.html
Copied to clipboard
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
        <title>Essential JS 2</title>
        <!-- Essential JS 2 autoComplete's dependent material theme -->
        <link href="//cdn.syncfusion.com/ej2/ej2-base/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-inputs/styles/material.css" rel="stylesheet" type="text/css"/>
        <link href="//cdn.syncfusion.com/ej2/ej2-dropdowns/styles/material.css" rel="stylesheet" type="text/css"/>

      <!-- Essential JS 2 all script -->
        <!-- <script src="https://cdn.syncfusion.com/ej2/dist/ej2.min.js" type="text/javascript"></script> -->

        <!-- Essential JS 2 autoComplete's dependent scripts -->
        <script src="//cdn.syncfusion.com/ej2/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-data/dist/global/ej2-data.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
        <script src="//cdn.syncfusion.com/ej2/ej2-dropdowns/dist/global/ej2-dropdowns.min.js" type="text/javascript"></script>

   </head>
   <body>
       <!-- Add the HTML <input> element  -->
         <input type="text" id='atcelement' />
        <script>
            let sportsData = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Gymnastics', 'Hockey', 'Rugby', 'Snooker', 'Tennis'];
            // initialize AutoComplete component
            var listObj = new ej.dropdowns.AutoComplete({
            //set the data to dataSource property
                dataSource: sportsData,
                //set width to suggestion list
                popupWidth: '250px',
                // set the popup list height
                popupHeight: "250px",
                // set placeholder to AutoComplete input element
                placeholder: "Find a game"});
            listObj.appendTo('#atcelement');
        </script>
   </body>
  </html>

See Also