Getting started with Angular Switch component
11 Jul 20245 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
Syncfusion packages are distributed in npm as @syncfusion
scoped packages. You can get all the Angular Syncfusion package from npm link.
Currently, Syncfusion provides two types of package structures for Angular components,
- Ivy library distribution package format
- Angular compatibility compiler(Angular’s legacy compilation and rendering pipeline) package.
Ivy library distribution package
Syncfusion Angular packages(>=20.2.36
) has been moved to the Ivy distribution to support the Angular Ivy rendering engine and the package are compatible with Angular version 12 and above. To download the package use the below command.
Add @syncfusion/ej2-angular-buttons
package to the application.
npm install @syncfusion/ej2-angular-buttons --save
Angular compatibility compiled package(ngcc)
For Angular version below 12, you can use the legacy (ngcc) package of the Syncfusion Angular components. To download the ngcc
package use the below.
Add @syncfusion/ej2-angular-buttons@ngcc
package to the application.
npm install @syncfusion/ej2-angular-buttons@ngcc --save
To mention the ngcc package in the package.json
file, add the suffix -ngcc
with the package version as below.
@syncfusion/ej2-angular-buttons:"20.2.38-ngcc"
Note: If the ngcc tag is not specified while installing the package, the Ivy Library Package will be installed and this package will throw a warning.
Adding Syncfusion Switch component
Modify the template in app.component.ts
file to render the Switch component.
import { SwitchModule } from '@syncfusion/ej2-angular-buttons'
import { Component } from '@angular/core';
@Component({
imports: [
SwitchModule
],
standalone: true,
selector: 'app-root',
template: `<div class="e-section-control">
<!-- To Render Switch with checked state. -->
<ejs-switch [checked]="true"></ejs-switch></div>`
})
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,
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SwitchModule } from '@syncfusion/ej2-angular-buttons'
import { enableRipple } from '@syncfusion/ej2-base'
import { Component } from '@angular/core';
@Component({
imports: [
SwitchModule
],
standalone: true,
selector: 'app-root',
template: `<div class="e-section-control">
<!-- To Render Switch with checked state. -->
<ejs-switch [checked]="true"></ejs-switch></div>`
})
export class AppComponent { }
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
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
.
import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { SwitchModule } from '@syncfusion/ej2-angular-buttons'
import { Component } from '@angular/core';
@Component({
imports: [
SwitchModule
],
standalone: true,
selector: 'app-root',
template: `<div class="e-section-control">
<!-- To Render Switch. -->
<ejs-switch onLabel="ON" offLabel="OFF" [checked]="true"></ejs-switch>
</div>`
})
export class AppComponent { }
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Switch does not have text support for material themes, and does not support long custom text.