This section explains how to create a simple CheckBox, and demonstrate the basic usage of the CheckBox module in an Angular environment.
The following list of dependencies are required to use the CheckBox module in your application.
|-- @syncfusion/ej2-angular-buttons
|-- @syncfusion/ej2-angular-base
|-- @syncfusion/ej2-base
|-- @syncfusion/ej2-buttons
You can use Angular CLI to setup your Angular applications. To install Angular CLI use the following command.
npm install -g @angular/cli
Start a new Angular application using below Angular CLI command.
ng new my-app
cd my-app
To install CheckBox package, use the following command.
npm install @syncfusion/ej2-angular-buttons --save
The above package installs CheckBox dependencies which are required to render the component in the Angular environment.
Import CheckBox module into Angular application(app.module.ts) from the package
@syncfusion/ej2-angular-buttons
.
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
// Imported Syncfusion checkbox module from buttons package.
import { CheckBoxModule } from '@syncfusion/ej2-angular-buttons';
import { AppComponent } from './app.component';
@NgModule({
imports: [ BrowserModule, CheckBoxModule ], // Registering EJ2 Checkbox Module.
declarations: [ AppComponent ],
bootstrap: [ AppComponent ]
})
export class AppModule { }
Modify the template in app.component.ts
file to render the CheckBox component.
import { Component } from '@angular/core';
@Component({
selector: 'app-root',
template: `<!-- To Render CheckBox. -->
<ejs-checkbox label="Default"></ejs-checkbox>`
})
export class AppComponent { }
Add CheckBox component’s styles as given below in style.css
.
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
Run the application in the browser using the following command:
ng serve
The below example shows a basic CheckBox component,
import { Component } from '@angular/core';
@Component({
selector: 'app-root',
template: `<!-- To Render CheckBox. -->
<ejs-checkbox label="Default"></ejs-checkbox>`
})
export class AppComponent { }
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { CheckBoxModule } from '@syncfusion/ej2-angular-buttons';
import { AppComponent } from './app.component';
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
/**
* Module
*/
@NgModule({
imports: [
BrowserModule,
CheckBoxModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';
enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);
The Essential JS 2 CheckBox contains 3 different states visually, they are:
The CheckBox checked
property is used to handle the checked and unchecked state.
In checked state a tick mark will be added to the visualization of CheckBox.
CheckBox indeterminate state can be set through indeterminate
property.
CheckBox indeterminate state masks the real value of CheckBox visually. Checkbox cannot be changed to indeterminate state through the user interface,
this state can be achieved only through the property.
import { Component } from '@angular/core';
@Component({
selector: 'app-root',
template: `<ul>
<!-- checked state. -->
<li><ejs-checkbox label="Checked State" [checked]="true"></ejs-checkbox></li>
<!-- unchecked state. -->
<li><ejs-checkbox label="Unchecked State"></ejs-checkbox></li>
<!-- indeterminate state. -->
<li><ejs-checkbox label="Indeterminate State" [indeterminate]="true"></ejs-checkbox></li>
</ul>`
})
export class AppComponent { }
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { CheckBoxModule } from '@syncfusion/ej2-angular-buttons';
import { AppComponent } from './app.component';
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
/**
* Module
*/
@NgModule({
imports: [
BrowserModule,
CheckBoxModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';
enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);