HelpBot Assistant

How can I help you?

Getting started in EJ2 JavaScript Check box control

10 Feb 202615 minutes to read

This section explains the steps required to create a simple Essential^® JS 2 CheckBox and demonstrate the basic usage of the CheckBox control in a JavaScript application.

Dependencies

The list of dependencies required to use the CheckBox component in your application is given below:

|-- @syncfusion/ej2-buttons
    |-- @syncfusion/ej2-base

Setup for local environment

Refer to the following steps to set up your local environment.

Step 1: Create a root folder named my-app for your application.

Step 2: Create a my-app/resources folder to store local scripts and styles files.

Step 3: Open Visual Studio Code and create my-app/index.js and my-app/index.html files to initialize the Essential^® JS 2 CheckBox control.

Adding Syncfusion^® resources

The Essential^® JS 2 CheckBox control can be initialized by using either of the following ways.

Using local script and style.
Using CDN link for script and style.

Using local script and style references in a HTML page

Step 1: Create an app folder quickstart for getting started.

Step 2: Obtain the global scripts and styles from the Essential Studio^® JavaScript (Essential JS 2) build installed location.

Syntax:

Dependency Script: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{DEPENDENCY_PACKAGE_NAME}\dist\global\{DEPENDENCY_PACKAGE_NAME}.min.js

Control Script: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{PACKAGE_NAME}\dist\global\{PACKAGE_NAME}.min.js

Dependency Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{DEPENDENCY_PACKAGE_NAME}\styles\material.css

Control Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\{PACKAGE_NAME}\styles\material.css

Example:

Dependency Script: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-base\dist\global\ej2-base.min.js

Control Script: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-buttons\dist\global\ej2-buttons.min.js

Dependency Styles: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-base\styles\material.css

Control Styles: C:\Program Files (x86)\Syncfusion\Essential Studio\JavaScript - EJ2\16.3.0.17\Web (Essential JS 2)\JavaScript\ej2-buttons\styles\material.css

The following script and style file contains all Syncfusion^® JavaScript (ES5) UI control resources in a single file:

Scripts: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\ej2\dist\ej2.min.js

Styles: **(installed location)**\Syncfusion\Essential Studio\JavaScript - EJ2\{RELEASE_VERSION}\Web (Essential JS 2)\JavaScript\ej2\material.css

Use the Custom Resource Generator (CRG) online web tool to generate custom scripts and styles for specific controls. This tool is useful for combining required control scripts and styles in a single file.

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

Step 4: Create a HTML page (index.html) in ~/quickstart/index.html location and add the Essential^® JS 2 script and style references.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <title>Essential JS 2</title>
        <!-- Essential JS 2 Base's material theme (Dependency Styles) -->
        <link href="resources/base/material.css" rel="stylesheet" type="text/css"/>
        <!-- Essential JS 2 CheckBox's material theme (Control Styles) -->
        <link href="resources/buttons/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 Base's global script (Dependency Script) -->
        <script src="resources/base/ej2-base.min.js" type="text/javascript"></script>
        <!-- Essential JS 2 CheckBox's global script (Control Script) -->
        <script src="resources/buttons/ej2-buttons.min.js" type="text/javascript"></script>
    </head>
    <body>
    </body>
</html>

Step 5: Now, add the CheckBox element and initiate the Syncfusion^® JavaScript (ES5) CheckBox controls in the ~/quickstart/index.html by using following code

<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
      <head>
          <title>Essential JS 2</title>
          <!-- Essential JS 2 Base's material theme (Dependency Styles) -->
          <link href="resources/base/material.css" rel="stylesheet" type="text/css"/>
          <!-- Essential JS 2 CheckBox's material theme (Control Styles) -->
          <link href="resources/buttons/material.css" rel="stylesheet" type="text/css"/>

          <!-- Essential JS 2 Base's global script (Dependency Script) -->
          <script src="resources/base/ej2-base.min.js" type="text/javascript"></script>
          <!-- Essential JS 2 CheckBox's global script (Control Script) -->
          <script src="resources/buttons/ej2-buttons.min.js" type="text/javascript"></script>
      </head>
       <body>
            <!--element which is going to render-->
            <input id="element" type="checkbox"/>
            <script>
                // Initialize CheckBox control.
                var checkbox = new ej.buttons.CheckBox({ label: 'Default' });

                // Render initialized CheckBox.
                checkbox.appendTo('#element');
            </script>
       </body>
  </html>

Step 6: Run the index.html in a web browser to render the Syncfusion^® JavaScript CheckBox control.

Using CDN link for script and style reference

Step 1: Create an app folder quickstart for getting started.

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

Syntax:

Dependency Script: https://cdn.syncfusion.com/ej2/{DEPENDENCY_PACKAGE_NAME}/dist/global/{PACKAGE_NAME}.min.js

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

Dependency Styles: https://cdn.syncfusion.com/ej2/{DEPENDENCY_PACKAGE_NAME}/styles/material.css

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

Example:

Script: https://cdn.syncfusion.com/ej2/ej2-buttons/dist/global/ej2-buttons.min.js

Styles: https://cdn.syncfusion.com/ej2/ej2-buttons/styles/material.css

Step 3: Create a HTML page (index.html) in ~/quickstart/index.html location and add the CDN link references. Now, add the CheckBox element and initiate the Syncfusion^® JavaScript CheckBox control in the index.html by using following code.

index.html
styles.css
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
                
        <title>Essential JS 2</title>

        <!-- Essential JS 2 Base's material theme (Dependency Styles) -->
        <link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 CheckBox's material theme (Control Styles) -->
        <link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-buttons/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 Base's global script (Dependency Script) -->
        <script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>

        <!-- Essential JS 2 CheckBox's global script (Control Script) -->
        <script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>

        <link href="styles.css" rel="stylesheet">
   <script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
   <body>
       <!--element which is going to render-->
        <input id="element" type="checkbox"/>
        <script>
            ej.base.enableRipple(true);

            // Initialize CheckBox control.
            var checkbox = new ej.buttons.CheckBox({ label: 'Default' });

            // Render initialized CheckBox.
            checkbox.appendTo('#element');
        </script>
   </body>
  </html>
#container {
    visibility: hidden;
}

#loader {
  color: #008cff;
  height: 40px;
  width: 30%;
  position: absolute;
  top: 45%;
  left: 45%;
}

li {
  list-style: none;
}

.e-checkbox-wrapper {
  margin-top: 18px;
}

.e-checkicon.e-checkbox-wrapper .e-frame.e-check::before {
    content: '\e790';
}

.e-checkicon.e-checkbox-wrapper .e-check {
    font-size: 8px;
}

.e-checkicon.e-checkbox-wrapper .e-frame.e-check {
    background-color: white;
    border-color: grey;
    color: grey;
}

.e-checkicon.e-checkbox-wrapper:hover .e-frame.e-check {
    background-color: white;
    border-color: grey;
    color: grey;
}

.e-checkicon.e-checkbox-wrapper .e-checkbox:focus + .e-frame.e-check {
    background-color: white;
    border-color: grey;
    box-shadow: none;
    color: grey;
}

.e-checkicon.e-checkbox-wrapper .e-ripple-element {
    background: grey;
}

Step 4: Run the index.html in a web browser to render the Syncfusion^® JavaScript CheckBox control.

Change the CheckBox state

The Essential^® JS 2 CheckBox contains 3 different states visually, they are:

Checked
Unchecked
Indeterminate

The CheckBox checked property manages the checked and unchecked states. When checked, a tick mark appears in the CheckBox visualization.

Indeterminate State

The CheckBox indeterminate state can be set through indeterminate property. CheckBox indeterminate state masks the real value of CheckBox visually. The Checkbox cannot be changed to indeterminate state through the user interface, this state can be achieved only through the property.

index.html
styles.css
<!DOCTYPE html>
  <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
                
        <title>Essential JS 2</title>

        <!-- Essential JS 2 Base's material theme (Dependency Styles) -->
        <link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 CheckBox's material theme (Control Styles) -->
        <link href="https://cdn.syncfusion.com/ej2/32.2.3/ej2-buttons/styles/material.css" rel="stylesheet" type="text/css"/>

        <!-- Essential JS 2 Base's global script (Dependency Script) -->
        <script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>

        <!-- Essential JS 2 CheckBox's global script (Control Script) -->
        <script src="https://cdn.syncfusion.com/ej2/32.2.3/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>

        <link href="styles.css" rel="stylesheet">
  
   <script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
   <body>
       <!--element which is going to render-->
        <input type="checkbox" id="checkbox1"/>
        <input type="checkbox" id="checkbox2"/>
        <input type="checkbox" id="checkbox3"/>
        <script>
            ej.base.enableRipple(true);

            //checked state.
            var checkbox = new ej.buttons.CheckBox({ label: 'Checked State', checked: true });
            checkbox.appendTo('#checkbox1');

            //unchecked state.
            checkbox = new ej.buttons.CheckBox({ label: 'Unchecked State' });
            checkbox.appendTo('#checkbox2');

            //indeterminate state.
            checkbox = new ej.buttons.CheckBox({ label: 'Indeterminate State', indeterminate: true });
            checkbox.appendTo('#checkbox3');
        </script>
   </body>
  </html>
#container {
    visibility: hidden;
}

#loader {
  color: #008cff;
  height: 40px;
  width: 30%;
  position: absolute;
  top: 45%;
  left: 45%;
}

li {
  list-style: none;
}

.e-checkbox-wrapper {
  margin-top: 18px;
}

.e-checkicon.e-checkbox-wrapper .e-frame.e-check::before {
    content: '\e790';
}

.e-checkicon.e-checkbox-wrapper .e-check {
    font-size: 8px;
}

.e-checkicon.e-checkbox-wrapper .e-frame.e-check {
    background-color: white;
    border-color: grey;
    color: grey;
}

.e-checkicon.e-checkbox-wrapper:hover .e-frame.e-check {
    background-color: white;
    border-color: grey;
    color: grey;
}

.e-checkicon.e-checkbox-wrapper .e-checkbox:focus + .e-frame.e-check {
    background-color: white;
    border-color: grey;
    box-shadow: none;
    color: grey;
}

.e-checkicon.e-checkbox-wrapper .e-ripple-element {
    background: grey;
}

Search docs

Ask HelpBot

Search docs

Ask HelpBot

How can I help you?

Getting started in EJ2 JavaScript Check box control

Dependencies

Setup for local environment

Adding Syncfusion^® resources

Using local script and style references in a HTML page

Using CDN link for script and style reference

Change the CheckBox state

Indeterminate State

How can I help you?

Getting started in EJ2 JavaScript Check box control

Dependencies

Setup for local environment

Adding Syncfusion® resources

Using local script and style references in a HTML page

Using CDN link for script and style reference

Change the CheckBox state

Indeterminate State

Adding Syncfusion^® resources