Getting started with Angular Switch component

24 Jun 2022 / 3 minutes to read

This section explains how to create a simple Switch, and demonstrate the basic usage of the Switch module in an Angular environment.

Dependencies

The following list of dependencies are required to use the Switch module in your application.

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

Setup Angular environment

You can use Angular CLI to setup your Angular applications. To install Angular CLI use the following command.

npm install -g @angular/cli

Create an Angular application

Start a new Angular application using below Angular CLI command.

ng new my-app
cd my-app

Installing Syncfusion Switch package

To install Switch package, use the following command.

npm install @syncfusion/ej2-angular-buttons --save

The above package installs Switch dependencies which are required to render the Switch component in the Angular environment.

Adding Switch module

Import Switch 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 Switch module from buttons package.
import { SwitchModule } from '@syncfusion/ej2-angular-buttons';

import { AppComponent }  from './app.component';

@NgModule({
 imports:      [ BrowserModule, SwitchModule ], // Registering EJ2 Switch Module.
 declarations: [ AppComponent ],
 bootstrap:    [ AppComponent ]
})
export class AppModule { }

Adding Syncfusion Switch component

Modify the template in app.component.ts file to render the Switch component.

import { Component } from '@angular/core';

@Component({
 selector: 'app-root',
 template: `<!-- To Render Switch with checked state. -->
            <ejs-switch [checked]="true"></ejs-switch>`
})
export class AppComponent  { }

Adding CSS reference

Add Switch 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';

Running the application

Run the application in the browser using the following command:

ng serve

The below example shows a basic Switch component,

Source

Preview

app.component.ts

app.module.ts

main.ts

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    template: `<!-- To Render Switch with checked state. -->
               <ejs-switch [checked]="true"></ejs-switch>`
})

export class AppComponent { }

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { SwitchModule } from '@syncfusion/ej2-angular-buttons';
import { AppComponent } from './app.component';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

/**
 * Module
 */
@NgModule({
    imports: [
        BrowserModule,
        SwitchModule
    ],
    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);

Set text on Switch

This section explains how to set onLabel and offLabel texts on Switch. In the following example, onLabel is set as ON and offLabel is set as OFF.